docs-review 是一个审查文档变更的技能,主要面向 Cloudflare 文档仓库的 PR,关注正确性、风格与结构。
用途:当被要求审查文档 PR、提出修改建议或补充反馈时加载。
主要能力:依据 .agents/references/style-guide.md 中的规范(MDX 语法、frontmatter、写作风格、格式、链接、代码块、提示块)检查变更,并可读取 src/content/docs/style-guide/ 中的完整风格指南。
使用方式:先决定是建议还是直接改。用户明确说 suggest 或不要改动时,只用 gh CLI 发布建议,不推送提交;说 fix 或 update 时直接编辑并提交。若调用者不是 PR 作者,通常只发建议;若是作者或身份不明确,默认直接修复,尤其是 MDX 语法、代码错误等明显问题。发布行级建议使用 gh api,先获取 PR 编号与最新提交 SHA:PR_NUMBER=$(gh pr view --json number -q '.number') 与 COMMIT_SHA=$(gh pr view --json commits -q '.commits[-1].oid'),然后针对单行或多行评论,设置 commit_id、path、line、side="RIGHT"、subject_type="line";多行还需 start_line 与 start_side。数值字段用 -F。发布 3 条以上建议时,可用 /pulls/${PR_NUMBER}/reviews 加 --input - 一次性批量提交。
审查流程:读取完整 diff(gh pr diff ${PR_NUMBER})并结合上下文判断,再按规则检查未转义 MDX 字符、组件导入、Workers 代码须用 TypeScriptExample、配置须用 WranglerConfig 与 $today、安装命令须用 PackageManagers、代码块语言小写、内部链接根相对且带尾斜杠、frontmatter 必含 title 与 description、内容准确性等。按严重程度排序:构建阻断、内容错误、缺少最佳实践、风格结构。输出时每条评论只保留新信息,摘要用一行结论加问题列表,不罗列通过项、不写表扬、不重复已发建议。
限制:资料未提供该技能的安装方式、收费、平台支持等细节;具体规则以仓库内风格指南为准。