update-nav
Update Navigation
Add new documentation pages to the docs.json navigation structure.
Instructions
-
Identify the page: Determine which page needs to be added to navigation
- If not specified, ask the user which file/page to add
- Confirm the file path is correct (relative to docs root)
-
Determine navigation group: Figure out where in the navigation this belongs
- Ask which navigation group it should go in if not specified
- Common groups align with user journey: "Get started", "Customize", "Deploy", "Settings", etc.
- Read docs.json to see current navigation structure and group names
-
Read current docs.json:
- Understand the existing navigation structure
- Find the correct group to add to
- Note the format and patterns used
-
Update docs.json:
- Add the new page entry to the appropriate navigation group
- Maintain consistent formatting
- Preserve alphabetical or logical ordering within the group if applicable
- Ensure proper JSON syntax
-
Show changes:
- Show the user what was added to docs.json
- Confirm the placement is correct
Navigation structure notes
- Pages are organized by user journey, not by file structure
- Navigation group names should match existing patterns
- Each entry typically includes just the file path (e.g., "content/components/accordions")
- Only update the English language section of the docs.json navigation. Updates to all translated content, including docs.json, are handled automatically after changes are made to English language files
Example
If user says "Add the new dark-mode.mdx page to the Customize navigation":
- Verify file exists at the specified path
- Read docs.json to find the "Customize" group
- Add "content/settings/dark-mode" to the appropriate location in that group
- Show the diff for confirmation
More from mintlify/docs
mintlify
Build and maintain documentation sites with Mintlify. Use when creating docs pages, configuring navigation, adding components, or setting up API references.
1.5Kdoc-reader
Read and navigate external documentation efficiently. Invoke when the task requires checking how a specific function, endpoint, or configuration option works; when the user references an API, SDK, library, or third-party tool by name; when any docs URL or documentation site is mentioned; or when implementing something that depends on an external service or package.
23doc-author
Write, edit, and maintain documentation. Use for collaborative drafting, autonomous writing, or improving existing docs. Defaults to collaborative mode where the human makes final decisions. Built by Mintlify.
22