Skip to content

✨ Enhancement: Enhance Documentation Navigation with Fixed Left Panel and Table of Contents. #1274

@cbum-dev

Description

@cbum-dev

Is your feature request related to a problem? Please describe

Currently, navigating through the documentation can be challenging, especially when dealing with lengthy pages. The left panel navigation bar is not fixed, so users lose access to it when scrolling down. Additionally, there is no table of contents (TOC) for quick access to sections on a single page, making it harder to locate specific content efficiently.
image

Describe the solution you'd like

Fixed Left Panel: The left panel navigation bar should remain fixed (sticky) while scrolling through the page to ensure users can always access it.
Table of Contents (TOC): Add an auto-generated table of contents at the top of each page (or as a floating menu on the right side) to allow quick navigation to specific sections within the page. This TOC should reflect the hierarchy of headings in the documentation and dynamically highlight the section currently being viewed.

Describe alternatives you've considered

Implementing collapsible subsections in the left navigation panel, but this might not resolve the issue for larger single-page content.

Additional context

Making the left panel fixed will significantly enhance the usability for users reading long documentation pages.
A TOC will improve accessibility and organization, ensuring users can quickly locate the information they need.

Are you working on this?

Yes

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: TriageThis is the initial status for an issue that requires triage.✨ EnhancementIndicates that the issue suggests an improvement or new feature.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions