Skip to content

Improve Intro and Getting Started documentation #4648

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

Closed
davidfischer opened this issue Sep 19, 2018 · 3 comments
Closed

Improve Intro and Getting Started documentation #4648

davidfischer opened this issue Sep 19, 2018 · 3 comments
Labels
Needed: documentation Documentation is required
Milestone

Comments

@davidfischer
Copy link
Contributor

I think the introduction and getting started guide could use a few improvements to make it easier for brand new users who may not already know about Sphinx/MkDocs/Markdown/RestructuredText and are just looking for a guide on how to write some docs.

I also think our introduction could stand some improvements to point users in the right direction. We have a lot of docs, but a few layout and explanation improvements will help users find the right section for them.

Here are some specific goals and improvements:

  • Make it easier to start a brand new docs project
    • Have a getting started guide for Sphinx
    • Have a getting started guide for Sphinx with commonmark
    • Have a getting started guide for MkDocs
    • Explain the why between the above technologies
  • Improve the intro paragraphs ("Read the Docs hosts documentation for...") on the index page to explain RTD's value proposition and why somebody should choose Read the Docs.
  • Full sentence/paragraph descriptions on different sections (eg. User documentation) rather than just a big toctree.
@davidfischer davidfischer added this to the Documentation milestone Sep 19, 2018
@RichardLitt RichardLitt added the Needed: documentation Documentation is required label Sep 20, 2018
@RichardLitt
Copy link
Member

I think this is a great idea, and needed. I still don't fully grok how to do this, either.

Aside: Is there a reason there are two milestones, Documentation and Better User Documentation? Could we join them?

@ericholscher
Copy link
Member

Some existing content which might be useful to steal:

@davidfischer
Copy link
Contributor Author

Aside: Is there a reason there are two milestones, Documentation and Better User Documentation? Could we join them?

I don't know the answer to this. Perhaps @agjohnson does?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants