SuperAPI AI 工具集

repo-website-api-update

写作与研究

查看项目

更新于 10-16 02:39

技能介绍

用途:在源代码变更后同步更新现有 API 文档页面,确保文档与库变更一致。适用前提是已阅读 repo-website-api-create 技能中 properties.ts 与 index.mdx 的写法模式。当函数签名、泛型、参数、返回类型、接口属性、JSDoc 描述或影响示例的行为发生变化时应当更新;内部实现、测试和非 JSDoc 注释变更无需更新。

主要能力与流程:完整阅读源文件而非只看 diff;将变更归类为新增、删除或修改;更新 properties.ts 使类型与源精确一致,可选对象键保留原键名并用 undefined 联合类型置于末位而非加问号;更新 index.mdx 的签名、泛型、参数与示例;更新相关文件如类型文档和 menu.md。

常见变更类型:新增参数(如为 action 增加 message 重载,需加 TMessage 泛型与参数、更新签名和示例)、删除参数(破坏性变更,需考虑迁移说明)、类型约束变更、接口新增属性、函数重命名(改文件夹、更新所有引用、menu.md 保持字母序、更新交叉引用、考虑重定向)、废弃(index.mdx 顶部加提示)、引入新辅助类型、新增同步与异步重载。

验证与限制:更新后需核对类型与源一致、签名匹配、示例可用、链接有效、类型文档与 menu.md 同步。建议按 properties.ts → index.mdx → 相关文件增量更新,不记录内部实现,保持示例质量。遇到重大破坏性变更、复杂泛型约束、意图不明或涉及大量关联文件时应寻求帮助。