Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upParsl Documentation Organization #1331
Comments
This comment has been minimized.
This comment has been minimized.
|
Would a better index do what you want? |
This comment has been minimized.
This comment has been minimized.
|
Index as in the landing page or index as in expanding the TOC sidebar? |
This comment has been minimized.
This comment has been minimized.
|
I was thinking of https://parsl.readthedocs.io/en/latest/genindex.html |
This comment has been minimized.
This comment has been minimized.
|
For myself, I don't find genindices very useful. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
dgasmith commentedOct 4, 2019
When approaching the documentation it takes quite a few clicks to find the area that I am looking for. A recent example was trying to find the description of blocks, I went through tutorial, user guide, FAQ, and reference before starting to search closely through the user guide.
A possible solution to this is to have additional high level categories such as:
Having some of the topics pre-expanded like here could be useful as well. Though the example TOC is probably too long!