Skip to content

DOC: Fix navigation inconsistencies in Overview, Setup, and Frontend sections #985

@skyforge-glitch

Description

@skyforge-glitch

What's wrong with the existing documentation

Description

While reviewing the documentation navigation, I noticed a few inconsistencies that affect discoverability and clarity for contributors. These are documentation-only navigation issues, not content or code problems.


Summary of changes

  • The Overview section now explicitly lists its existing sub-pages (Features and Architecture) instead of appearing empty in the sidebar.
  • The Setup section groups Quick, Manual, and Script setup guides under a single expandable section for consistency with other docs sections.
  • The Frontend section links have been updated to match the actual existing documentation files, removing references to non-existent pages.

Why this helps

  • Improves sidebar consistency across sections
  • Avoids empty or misleading navigation entries
  • Makes setup and frontend documentation easier to discover for new contributors

Status

I have already implemented this change locally and can open a PR if this approach looks good.

Scope

  • Documentation only
  • MkDocs navigation change only
  • No content or runtime changes

Add ScreenShots

Currently, the Overview, Setup, and Frontend sections in the sidebar are not consistently structured, some appear without their actual child pages, while others link to pages that don’t exist. This results in empty-looking sections, broken expectations, and reduced discoverability for contributors browsing the documentation.

After Changes

Image

Record

  • I agree to follow this project's Code of Conduct
  • I want to work on this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions