Skip to content

[DOC] Add the navigation of the documentation for the website - #888

Draft
Nexucis wants to merge 1 commit into
mainfrom
nexucis/docs-nav
Draft

Nexucis wants to merge 1 commit into
mainfrom
nexucis/docs-nav

Conversation

@Nexucis

@Nexucis Nexucis commented Oct 21, 2026

Copy link
Copy Markdown
Member

Description

The new website perses.dev (perses/website#171) reads docs/nav.yaml to build the navigation of each published version of the documentation, so the navigation evolves with the documentation of each version. Until a version contains this file, the website uses a copy of the navigation maintained in the website repository.

The content of this file is the navigation currently used by the website for the latest version. A header explains the syntax, close to the nav section of mkdocs:

- overview.md                          # page, the title is the first h1 of the page
- Getting started: getting-started.md  # page with an explicit title
- Concepts:                            # section
    - Dashboard: concepts/dashboard.md
- Helm: helm-charts:installation.md    # page of another documentation of the website
- Plugins: /docs/plugins/              # link to another page of the website
- Demo: https://demo.perses.dev        # external link

From now on, when a page is added, moved or removed in docs/, docs/nav.yaml should be updated in the same PR. A page missing from the navigation is still published, but can only be reached through links and the search.

I validated the file with the website: it is picked up, every page of docs/ is referenced and every entry resolves to an existing page.

Screenshots

N/A

Checklist

  • Pull request has a descriptive title and context useful to a reviewer.
  • Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
    following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
  • All commits have DCO signoffs.

The website perses.dev reads docs/nav.yaml to build the navigation of
each published version of the documentation, so the navigation evolves
with the documentation (see perses/website#171).

Signed-off-by: Augustin Husson <augustin.husson@amadeus.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant