Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp the Docs #165

Open
tmontes opened this issue Aug 26, 2021 · 0 comments
Open

Revamp the Docs #165

tmontes opened this issue Aug 26, 2021 · 0 comments
Labels
@ docs Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@tmontes
Copy link
Member

tmontes commented Aug 26, 2021

FEELING:

  • Most of the current docs are blog-like prose sharing thoughts, vision, ideas.
  • Index/front page describes usage.

LET's

  • Have index page focus on installing and minimal usage.
  • Have other pages describing particular use cases.
  • Have other pages describing (archiving) thoughts -- maybe as a series of ToPs documents (thoughts on pup), vaguely mirroring the idea of PEPs?
@tmontes tmontes added @ docs Improvements or additions to documentation enhancement New feature or request labels Aug 26, 2021
@tmontes tmontes added this to the LATER milestone Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@ docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant