The navigation property in docs.json controls the structure and information hierarchy of your documentation.
With proper navigation configuration, you can organize your content so that users can find exactly what they’re looking for.
Choose one primary organizational pattern at the root level of your navigation. Once you’ve chosen your primary pattern, you can nest other navigation elements within it.
Pages
Pages are the most fundamental navigation component. Each page is an MDX file in your documentation repository.
In the navigation object, pages is an array where each entry must reference the path to a page file.
Groups
Groups let you cluster related pages under a shared heading in the sidebar.
Root page
A root page gives the section a sensible landing route and summary content.
Directory listings
Directory listings can be generated from a folder when you want the filesystem to drive the page collection.
Default expanded state
Choose whether a group is open by default when the page first renders.
Tabs
Tabs help split larger documentation sets into separate top-level contexts without changing the overall shell.
Menus
Menus can expose parallel navigation collections for release notes, docs, or API surfaces.
Anchors
Anchors connect sidebar items to heading targets inside a markdown page.
Global anchors
Global anchors keep persistent deep links visible across a category.
Products
Products are useful when one docs deployment spans multiple offerings with distinct entry points.
Dropdowns
Dropdowns expose compact secondary navigation without overloading the main sidebar.
OpenAPI
OpenAPI routes can live alongside markdown pages while preserving the same framing components.
Versions
Versions let you expose multiple documentation snapshots in a predictable URL structure.
Default version
Mark one version as the default to keep incoming traffic on the primary docs set.
Version tags
Version tags help users understand stability and support windows.
Languages
Languages let one docs build expose multiple translated variants from a shared config.
Nesting
Nesting is useful, but keep it shallow enough that users never have to hunt for the content they need.
Breadcrumbs
Breadcrumbs add orientation once your information architecture begins to branch.
Interaction configuration
Interaction settings control copy buttons, ask boxes, and other page-level affordances.
Enable auto-navigation for groups
Auto-navigation can derive child pages from the filesystem when you want content structure to stay close to the repo tree.