Repository navigation
Add a table of contents to every piece of documentation content #97633
gilangabdian
started this conversation in
Ideas
Replies: 1 comment 6 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment



Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Goals
goal: Every piece of content in the Next.js docs has a Table of Contents (ToC).
Background
When I first learned NextJS, I used to learn from the official NextJS documentation, there I realized that in every available content I had to scroll from top to bottom to find the content that matched what I needed and if it turned out that the content was missed then I had to scroll up again to get to that content.
This makes me a little uncomfortable and I think it would be more convenient if each documentation content had a Table of Content (ToC) that could be clicked and if clicked it would automatically scroll to the menu that was clicked. I believe this would help new users quickly see what sub-menus or topics are covered on the page. For example, in the
Getting Started > Installationmenu, there are many submenus, there are quick start, system requirements, supported browsers, create with cli, manual installation and so on. If there is no ToC, the user has to scroll from top to bottom to find out what submenus/topics there are in the content, and if the user misses the topic/submenu they need, the user has to scroll up again. This makes it a little longer for users to find the submenus/topics in the content they need.That is why I am requesting this feature. To the maintainers, if you have time, please read the complaints I have experienced and whether this feature will be possible to be realized in the future? or maybe there are already plans for this feature? Or what?
But if this feature is intentionally left out for internal reasons, with respect, could I know why?
Proposal
How should this feature be implemented?
We should implement an automatic, sticky Table of Contents (ToC) on the right side of the page for all Next.js documentation.
With respect, if it is allowed, I would be happy to work on this feature and make sure it will not break other features.
All reactions