You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: