update-nav

支持将新文档页面按用户使用流程归类添加到导航结构中,自动识别并插入至“快速开始”“定制”“部署”等对应分组,保持与现有 docs.json 格式和排序规则一致,仅更新英文版导航配置。

快捷安装

在终端运行此命令,即可一键安装该 Skill 到您的 Claude 中

npx skills add mintlify/docs --skill "update-nav"

Update Navigation

Add new documentation pages to the docs.json navigation structure.

Instructions

  1. 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)
  2. 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
  3. Read current docs.json:

    • Understand the existing navigation structure
    • Find the correct group to add to
    • Note the format and patterns used
  4. 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
  5. Show changes:

    • Show the user what was added to docs.json
    • Confirm the placement is correct
  • 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”:

  1. Verify file exists at the specified path
  2. Read docs.json to find the “Customize” group
  3. Add “content/settings/dark-mode” to the appropriate location in that group
  4. Show the diff for confirmation