Site settings

Navigation

Organize sidebar sections, groups, and page order for your docs site navigation

What navigation controls

The Navigation page sets how readers move through your published docs site. It controls the sidebar and header structure: which sections appear, how pages are grouped inside them, and the order they appear in. Navigation arranges pages that already exist in your project's content. It does not create pages, so a page must exist before you can place it in the sidebar.

Open the page from the dashboard at /dashboard/projects/<projectId>/site/navigation, or from the Site settings view in the sidebar. Site settings share one state across Appearance, Navigation, Domains, SEO and sharing, Features, and Advanced JSON. Changes are saved with the rest of your site configuration and appear on the published site after you publish the branch.

How navigation relates to your pages

Each page in your content has a route, which is the path readers use to open it. Navigation links those routes into a structure. Keep these rules in mind:

  • Navigation changes only where a page appears in the sidebar and header. They do not change the page's URL.

  • Navigation is stored on a branch, like the rest of your site settings. Publish the branch to make changes live.

  • Pages are edited separately in the content editor. See Editing Pages in the Content Editor.

Organizing sections and groups

The shared docs renderer shows a multi-level sidebar with collapsible sections. Use these levels:

LevelPurposeExample
SectionA top-level area of the site, shown in the sidebar or headerGetting Started
GroupA collapsible block of related pages inside a sectionInstallation
PageA single docs page, shown as a linkInstall the package

Use sections for major topics readers scan for, and groups for subtopics within a section. Keep groups short so the sidebar stays easy to scan.

Layout options

The site configuration includes layout options for the sidebar position and the placement of section tabs. These values are validated against the published JSON Schema, so an unknown value is rejected when you save. You can also review them in Advanced JSON.

Review checklist

Before you publish, confirm that:

  • Every section you added contains at least one page.

  • Each page you want readers to find appears in the sidebar.

  • The page titles in the sidebar match the titles readers see on each page.

  • The change looks correct on the branch preview. See Branches, Previews, Publishing, and Restore.