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
We determined that the top level documentation page should probably be restructured and help guide users better. Looking at the types of users that we have viewing our documentation, and the context with which they arrive at the top level documentation page, there were a few changes that we discussed:
The marketing material is important, but can be reduced. The top level documentation page isn't the best place to sell users -- the main product pages are a better place for this
The toctree directive just plops all of our headings out in a list, we should instead curate them, group them, and make the flow of our documentation easier for users to digest
The text was updated successfully, but these errors were encountered:
The marketing material is important, but can be reduced. The top level documentation page isn't the best place to sell users -- the main product pages are a better place for this
I agree with this in theory but not strictly in practice. The big issue with docs.readthedocs.io is that it is the top level page. Clicking the logo or "home" goes to that page rather than to readthedocs.org. That is the reason why we need some marketing material ("what is RTD?" and "Why RTD") right at the top of that page.
Comparing our documentation with vaguely similar projects like Travis CI or Circle CI both pages link back to the home page for those respective projects/companies and that's where the bulk of the marketing material lives. Until we do the same, I believe that we need a bit more marketing material.
We determined that the top level documentation page should probably be restructured and help guide users better. Looking at the types of users that we have viewing our documentation, and the context with which they arrive at the top level documentation page, there were a few changes that we discussed:
The text was updated successfully, but these errors were encountered: