Skip to content

Guide users more on top level documentation page #5675

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
agjohnson opened this issue May 7, 2019 · 2 comments · Fixed by #5819
Closed

Guide users more on top level documentation page #5675

agjohnson opened this issue May 7, 2019 · 2 comments · Fixed by #5819
Assignees
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

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
@agjohnson agjohnson added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels May 7, 2019
@humitos humitos added this to the Better user documentation milestone May 8, 2019
@humitos
Copy link
Member

humitos commented Jun 6, 2019

Kolibri project does this in an interesting way:

Screenshot_2019-06-06_13-03-22

https://kolibri.readthedocs.io/en/latest/

@davidfischer davidfischer self-assigned this Jun 17, 2019
@davidfischer
Copy link
Contributor

davidfischer commented Jun 17, 2019

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.

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

Successfully merging a pull request may close this issue.

3 participants