SuperAPI AI 工具集

docs-sync

编程与开发

查看项目

更新于 10-16 07:27

技能介绍

用途:docs-sync 用于检查 redis/node-redis 项目的文档覆盖情况,通过对比 master 分支的功能与配置选项,发现 docs/、顶层 README.md 和各 packages/*/README.md 中缺失、不正确或过时的内容,并提出针对性修改建议。

主要能力:确认分析范围与基准分支;从选定范围构建功能清单,关注公开导出、client/cluster/sentinel/pool 配置项、新增或变更命令、连接字符串选项、默认值和运行时行为;先做文档优先检查,逐页审阅现有文档;再做代码优先检查,将功能映射到合适页面;识别缺失、错误/过时和结构性问题;生成 Docs Sync Report 并请求用户批准;获批后修改文档,保持现有风格与导航,可运行代码片段放入 examples/ 或 doctests/,并用 npm run build 验证。

使用方式:先确认当前分支与默认分支 master;若当前分支不是 master,仅分析相对 master 的 diff;避免切换分支干扰本地改动,必要时用 git show master:<path> 或 git worktree add。可用 rg "Options"、rg "interface .Options"、rg "export" 等搜索选项类型与功能标志。Redis 命令行为以 packages//lib/commands 中的 parseCommand/transformReply 为准,仅在出现差异时参考 redis.io/commands 确认服务端语义。

适用场景:维护 redis/node-redis 文档、同步新功能说明、修正配置默认值或行为描述、改善文档结构可发现性。

限制:资料未提供具体收费、价格、平台或效果信息;报告模板与参考文件 references/doc-coverage-checklist.md 已给出,但未提供更多实现细节。