SuperAPI AI 工具集

update-docs

写作与研究

查看项目

更新于 10-15 19:58

技能介绍

用途:在 APEX 仓库发生内容变更后,遍历仓库并让所有文档表面与实际状态重新同步。适用时机包括:新增、删除、重命名技能或修改其 frontmatter;新增、删除或重命名 steering 工作流;手动编辑过 README 标记块;在提交涉及 skills/ 或 steering/ 的 PR 之前;用户要求“检查文档”“更新文档”或“同步文档”时。

主要能力:将文档表面分为两层。第一层为脚本管理的确定性表面,包括 README.md、skills/README.md、steering/**/.md 中的标记块,以及 Docusaurus 包装文件、manifest 和技能索引。判断是否过期使用 ./misc/update-all-references.sh --check 与 ./misc/update-pages.sh --check,任一退出码非零即重跑对应脚本,不重复实现脚本逻辑。第二层为散文表面,需要推理,检查过时引用,例如散文中的技能名与 skills/<name>/ 目录不匹配、旧 frontmatter 描述原样残留、已停用的 steering 工作流仍被列出、技能数量或覆盖范围声明与事实不符、重命名后的旧路径链接、已被移除或重命名的概念仍出现在贡献者指南中。候选集覆盖 README.md、CONTRIBUTING.md、CODE_OF_CONDUCT.md、THIRD_PARTY_NOTICES.md、skills 下的 README.md 与 SKILL.md、steering 下的 .md、devops-agent 相关文档、misc 下 evals 文档、misc/website/docs/intro.md、getting-started.md 以及 index.tsx。由脚本生成的 misc/website/docs/skills/.md、steering/.md、skills/index.md 和 static/manifests/skills.json 不应手工编辑。

使用方式:默认以 origin/main 为比较基准执行 git diff 确定变更集,也可按用户指定范围调整。运行模式有两种:编码代理模式下可直接执行脚本、提出 diff,机械性修复自动应用,面向用户的散文修改需先询问;纯聊天模式下不写文件,输出 PASS/STALE 表格和一行命令组成的修复清单。最终必须给出包含表面、状态、已采取动作和是否需要确认的汇总表,状态取值 PASS、STALE 或 SKIP,标记为需要确认的行应等待用户回复后再定稿。

限制:资料未提供该技能的安装命令、依赖版本、收费与价格、性能数据以及可用平台等细节,暂无法确认这些方面。