SuperAPI AI 工具集

git-doc-updater

通用与其它

查看项目

更新于 10-16 08:08

技能介绍

用途:在 Git 提交前自动同步项目文档,避免代码变更与文档脱节。触发方式包括“更新文档”“sync docs”“准备发布”,也可由 git-precommit 自动调用。

主要能力:使用 read_file、replace_string_in_file、get_changed_files、memory_bank_update_progress 等工具,按变更类型更新对应文档。README.md 在新功能或依赖变更时更新,调用 readme-updater;CHANGELOG.md 在任何代码变更时更新,调用 changelog-updater;ROADMAP.md 在完成里程碑时更新,调用 roadmap-updater;memory-bank/ 在每次提交时更新,调用 memory-updater。

使用方式:先通过 get_changed_files() 分析变更,再判断更新目标,例如 src/ 下新增文件对应 README、pyproject.toml 变更对应 README 安装说明、任何变更对应 CHANGELOG、ROADMAP 项目对应 ROADMAP,然后依序调用对应 Skill,最后用 memory_bank_update_progress() 同步进度。

适用场景:适合需要保持文档与代码同步的 Git 项目,尤其是提交前检查、发布准备和里程碑记录。

限制:资料未提供具体安装命令、配置方式、支持平台、收费信息及实际效果,相关细节暂未提供。