SuperAPI AI 工具集

setup

通用与其它

查看项目

更新于 10-15 21:09

技能介绍

用途:doc-sentinel:setup 是 doc-sentinel 的交互式配置向导,为项目创建 .doc-sentinel.json,用于后续的文档漂移检测。

主要流程:先探测项目结构(ls、查看 docs/ 目录、检查 AGENTS.md/ARCHITECTURE.md/CLAUDE.md/README.md/CHANGELOG.md 等顶层文档,检查是否已有 .doc-sentinel.json,以及是否存在 doc-sync、inkwell 配置);再搜索 *.md 文档(排除 node_modules、.git)和源码目录;然后交互式确认检测结果并生成配置;最后输出摘要,提示每次提交时钩子会检测漂移,并可用 /doc-sentinel:scan 生成基线报告。

配置字段:version(默认 1)、docs_root(默认 docs)、watch_files(默认 AGENTS.md、ARCHITECTURE.md、README.md)、ignore_sources(默认 .test.、.spec.、tests/**、*.d.ts)、ignore_docs(默认空)、severity(按文档类别设置漂移严重级别:architecture、agents_md 为 high,api_reference、readme 为 medium,changelog 为 low)。严重级别含义:high 立即标记,medium 会话结束时标记,low 仅出现在扫描报告中。

集成与限制:doc-sentinel 与 doc-sync/inkwell 互补,各自使用独立队列文件,不冲突;.doc-sentinel-drift.json 为临时文件建议加入 .gitignore,配置文件应提交。资料未提供安装命令、具体依赖平台、收费或更多使用步骤。