-
Notifications
You must be signed in to change notification settings - Fork 192
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
feat: add table of contents and remove accordion functionality #299
Conversation
306b372
to
42f0b00
Compare
I personally like having a table of contents for easier navigation, but RE: @gregwhitworth's comment, I'd like to hear from some of the folks who've looked into rearchitecting this UI |
@gregwhitworth agreed, I was unsure about it. I'm happy to implement a better UX. One thought I had was to just put the map of links inline at the top of the page? The thing is that the list of links can get very long. |
Yes, not a fan of the secondary ToC on the side there...a bit confusing but perhaps a dropdown that links to the different sections at the top or something? Let me think on this and look into some documentation heavy pages. |
I've looked over a few documentation heavy examples of websites and I see an iterative set of changes to make:
So # 1 is my proposed solution for this PR and # 2 is a larger proposal for the whole Nav / TOC that would be addressed in another PR. Thoughts? Yes/no? @gregwhitworth @una |
@ststimac I do think reworking the whole navigation, more along the lines of 2, makes a lot of sense. For 1, part of the problem is the quantity of items on that left menu. Right now it is actually screwed up on slightly lower resolution devices, where if the content on the right doesn't cause the page to scroll, the navigation on the left gets cut off (when too long). So if we add more content to the left nav, we need to fix the overflow/scrolling. |
Closing due to inactivity |
Table of contents is a simple list of links on the right side of the page. It disappears altogether on mobile (similar pattern as Wikipedia). It is not sticky on scroll (making it sticky will be tricky for components like button that have a lot of concepts and will require a nested scrollbar.
Right now this only shows up on the Analysis pages, but I could change it to show up on all the pages.
Resolves: #289