SuperAPI AI 工具集

docs-sync

编程与开发

查看项目

更新于 10-16 03:05

技能介绍

用途:对照主分支功能与配置选项,审计或更新英文 SDK 文档,找出覆盖缺口与不准确内容。

主要能力:确认范围与基线分支;从选定范围构建功能清单(公开导出、配置项、环境变量、CLI 命令、默认值、运行时行为);先做文档优先检查,遍历 docs/ 下相关页面(排除 docs/ja、docs/ko、docs/zh);再做代码优先检查,将功能映射到 docs/ 与 mkdocs.yml 的信息架构;检测缺失、错误或过时内容及结构问题;按模板输出 Docs Sync Report。

使用方式:审计或仅提案请求只报告不编辑;用户要求更新或已批准计划时完成本地编辑与必要检查。优先分析当前分支,分支范围请求才用分支差异。避免切换分支,优先只读检查如 git show main:<path>;确需单独检出时须先获 AGENTS.md 要求的明确批准。可用 rg "Settings"、rg "Config"、rg "os.environ"、rg "OPENAI_" 等搜索选项与特性开关。涉及 OpenAI 平台特性时调用 $openai-knowledge 获取最新细节,但以 SDK 源码为准。

限制:仅编辑 docs/** 下英文文档,不改翻译;新增或重命名页面需更新 mkdocs.yml;按 AGENTS.md 的文档验证层级运行所需检查,内容或结构变更在稳定后运行一次 make build-docs,纯编辑性变更不运行;docs/ref/* 页面以 src/ 中 docstring 为准,优先改代码注释而非手改生成页;未发布行为须先应用仓库的 Documentation Release Timing 政策。参考资料:references/doc-coverage-checklist.md。