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

Consistent index page table of contents look and feel #34

Open
eharkins opened this issue Oct 26, 2020 · 0 comments
Open

Consistent index page table of contents look and feel #34

eharkins opened this issue Oct 26, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@eharkins
Copy link
Contributor

@trvrb raised on last week's Nextstrain call that it is a little disorienting (paraphrasing) to have some of the section header pages (AKA "index pages") just show a table of contents, e.g. https://docs.nextstrain.org/en/latest/guides/bioinformatics/index.html, while others have actual content (sometimes in addition to a table of contents), e.g. https://docs.nextstrain.org/en/latest/guides/share/index.html.

I'll leave it to Trevor to suggest the ideal layout for these pages, but one way to improve consistency in terms of displaying content and/or tables of contents would be to just make sure each of these pages have (in this order on the page):

  1. At least one sentence (or more in cases where there is a page worth of introductory content like https://docs.nextstrain.org/en/latest/guides/share/index.html) introducing the section
  2. Below that, the table of contents.
@eharkins eharkins added the enhancement New feature or request label Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant