SuperAPI AI 工具集

add-docs-page

写作与研究

查看项目

更新于 11-04 22:08

技能介绍

用途

本技能用于在 LangChain 文档站点(Mintlify 项目)上新增、移动、重命名或删除文档页面。核心认知是:页面不只是 MDX 文件,还必须同步更新导航条目;移动、重命名或删除时还需添加重定向,CI 会强制检查这两点。

主要流程

  1. 选择源目录:依据 AGENTS.md 中的“Source directory summary”表定位目录。注意目录名与导航名不一致(如 src/langsmith/fleet/ 显示为“No-code agents”),以及生命周期菜单会混合不同产品来源。严禁写入 build/ 目录,它是构建输出。
  2. 编写页面:必须包含 title 和 description 两个 frontmatter 字段,description 中不得含 Markdown、链接或反引号。OSS 多语言页面可用 :::python 和 :::js 围栏写在同一个文件中。使用不熟悉的 JSX 组件前,须查阅 Mintlify 组件文档或 MCP 服务器确认。所有事实必须来自产品源码,不得凭记忆或从相似页面复制;无法确认的内容应省略并在 PR 中列出。
  3. 添加导航条目:导航位于 src/docs.json 的 navigation.products 下。products[0] 是 AGENT DEVELOPMENT LIFECYCLE(Home、Build、Test、Deploy、Monitor),products[1] 是 PRODUCTS AND SETUP(LangSmith setup、LLM Gateway、No-code agents、Engine、Deep Agents Code)。多数菜单用 menu[].tabs[].pages[] 嵌套,Build 菜单用 menu[].dropdowns[].tabs[].pages[]。页面路径省略 src/ 前缀和扩展名。语言版本页面需在 Python 和 TypeScript 两个下拉中各加一条;新分组需以 index 页面开头。集成页面改加到组件 index.mdx 中,仅新建组件组时才改 docs.json。
  4. 移动/重命名/删除时加重定向:先运行仓库的 mover 工具(uv run docs mv ... --dry-run)重写交叉引用,注意处理输出中的警告;随后在 docs.json 的 redirects 数组添加重定向条目,路径以 / 开头,语言版本页面每种语言各需一条。CI 脚本 scripts/check_removed_pages_redirects.py 会检查缺失的重定向和 docs.json 中不存在的页面路径。
  5. 两个静默陷阱:同一内容块出现在三个及以上页面时应抽取为 src/snippets/ 下的片段,并验证构建产物中存在对应的 python/ 和 javascript/ 路径;修改标题文字会改变锚点 slug,从而破坏指向该锚点的链接,修改前应全库 grep 锚点引用。
  6. 验证:依次运行 make lint_prose FILES=...、make check-mdx、make broken-links-with-anchors。若遇 uv 版本不匹配,可直接用 PYTHONPATH 调用 pipeline 构建;新 worktree 需先 mise trust。修复所有 Vale 发现的问题。
  7. 审阅文案:编辑完成后调用 docs-review 技能检查被动语态、冗余、产品名大小写、结构惯例和链接文字等 Vale 无法覆盖的规则。微小的纯配置改动可跳过。
  8. 提交 PR:关联 Linear 问题时使用 Closes/Refs 链接;AI 披露仅写一句纯文本,如“Prepared with Claude Code”,不得添加徽章,否则 check-pr-ai-attribution 会失败。

适用场景

适用于 LangChain 文档站点的页面维护,包括新增页面、移动或重命名页面、删除页面、调整导航结构、提取共享片段以及修复锚点链接。

限制与要求

  • 不得写入 build/ 目录。
  • 所有事实必须从产品源码核实,无法确认时须省略并披露。
  • 标题改动可能静默破坏锚点链接,需提前搜索。
  • 重定向为 CI 强制项,移动、重命名或删除时必须添加。
  • 新 worktree 存在 uv 版本检查、mise 信任和 .venv 缺失等环境问题,需按文档中的规避方式处理。
  • PR 描述不得含 AI 生成徽章。