[Feature] Add Table of Contents

[Queen-codes]

Problem

The current documentation page of the vocabulary design system lacks a well-structured table of contents to enable users to jump to sections they need directly without having to scroll through a large amount of content. As of now, there are only three links that provide basic navigation on the page.

Description

• Create a table of contents that's accessible from the sidebar and allows users to jump into any section. The table of contents will break down each section into categories.
• Some sections will also be broken into subsections. For example, the components section will also have subsections and links to each component.

Alternatives

• To continue with the current navigation, but this would result in users having to scroll through long sections to find the information they need.

• Use a simple top navigation bar instead of a sidebar, but it may limit the space for more detailed sections and make it less easier to locate specific content quickly.

Implementation

• [x] I would be interested in implementing this feature.

[Queen-codes]

hello @possumbilities . I'd be happy to hear what you think of this issue. Looking forward to hearing from you.

[possumbilities]

This is a good issue, but intersects with the need to add some kind of CMS/SSG to the repository to manage what would become a rather large list of items. I'm moving this to status: blocked until further work around how documentation is going to be handled as it grows more complex here.

At the moment the documentation is very bare-bones to keep it simple until a CMS/SSG is decided so its easily migrated.

Definitely something we need to do, just after we've done a few other items.

[Queen-codes]

Thank youu @possumbilities. I understand and I'm hoping to contribute in any way I can when the time comes.