-
-
Notifications
You must be signed in to change notification settings - Fork 26k
DOC Improves sidebar navigation for user guide #16964
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
Conversation
I think this is a nice one to have, but I rather have this one, and a sort of global one as well. With this change, it's hard to navigate once the user goes to a UG or an example, since that part of the navigation is gone. |
I was trying to go for a UX where the navigation is done from the navigation bar itself. Kind of like how pandas did it . But I am okay with having the global one there as well. (It may be less LOC) |
pandas has 3 levels of navigation, the navigation bar, the local one (which they have on the right side), and another one on the left side which is kinda the parent of the local one. This PR now almost implements the local one which pandas has on the right side only. I also really like how the navigation is responsive to the scrolling in pandas, but no idea how hard/easy it is to implement. |
I would say its intermediate. (It's a bootstrap feature) We have a mixture. The TOC on the right can sometimes be the global or the local. On the PR when one is just on a index page such as supervised learning, it shows the toc just for the user guide. If one wants to navigate to another page, they can go to the top navbar. On the master supervised learning page it shows the local TOC which is not much. If one is on the user guide, a user can navigate from the nav bar as well. The same pages that appear on master. As for the example, this PR is the same as master. TLDR: This PR only updates the user guide TOC. |
In the original issue @amueller says
Isn't this PR doing the opposite? As far as I can tell the global overview isn't present anymore on the UG. |
Yea its the opposite, I change the comment at the top to state this is an alternative. I think having global everywhere would be be noise for long pages, such as the API page or any user guide page with many sections, since it is so many levels down. I think using the navbar to navigate between pages and using the side bar to navigate within a page is a better UI/UX. Sidenote: I will create another PR to place the global nav bar on the sidebar so we can compare them. |
#17033 places the global TOC on the sidebar everywhere. |
So far I prefer this one... I think? Hard to see and test. What I'm missing is subheadings (for in-page navigation) for Dataset loading utilities |
This PR only updates the navigation for the user guide.
The user guide is structured in a way where |
I like this! I think this is a good next step! |
Right now this is a "global" page for the user guide, right? I'd like to see the local on the right hand in a Pr on top of this. |
Yea it is a "global page" for the user guide. |
For reference, this is the current high level structure of the docs. Pages without toc are single pages, while pages with a TOC has more deeper levels.
|
I think this is great! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this! Clearly an improvement!
I'm a bit surprised by some of these. e.g. the "computing" page and the "Vizualisation" page where the sections are lost now. |
this is a nice improvement. I'm a little confused about the mixed use of numbered and unnumbered section titles. |
I rebuild the documentation to see the artifacts. @NicolasHug Could you give the link to the files that have missing sections. I could not see them. |
I don't exactly remember but I believe the TOC was missing on some pages like https://scikit-learn.org/stable/modules/computing.html (on the left) |
@thomasjpfan do you have responses to the minor critiques by @NicolasHug and myself above? |
@jnothman Both issues are addressed now:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is nice! Let's give it a whirl.
I'm a little uncomfortable about broken links to old documentation pages, but it should not be terrible.
@thomasjpfan There is now a merge conflict due to recently merged PR. |
Thanks as always, @thomasjpfan! |
Reference Issues/PRs
Alternative to #16951
What does this implement/fix? Explain your changes.
Updates the sidebar for the user guide for better navigation.