blender-knowledge-refresh 是用于 Blender 插件仓库的按版本文档刷新技能,目标是在一个 PR 内审查发生漂移的文档及其证据记录,保持文档准确且简短。
用途:针对下一个发布版本执行一次性的文档刷新。需在版本范围确定后、且没有其他刷新进行中时运行。该命令只打开一个 PR,不会合并刷新 PR 或发布 PR。
主要能力:根据 head 分支匹配 PR,而非文本搜索;从 head 分支以 release-please-- 开头的开放 PR 标题确定下一版本,若不存在则询问;若已存在 docs/knowledge-refresh- 分支则停止并报告;从 origin/main 创建独立 worktree 与刷新分支,并记录 origin/main 完整 SHA 作为 reviewed_revision;运行 check_knowledge.py 获取漂移列表,若出现非本次刷新导致的错误则停止。
使用方式:逐篇处理漂移文档。通过 git diff 查看 reviewed_revision 到 main SHA 之间与漂移条目 sources 相关的变更,只修正因变更而错误的内容。用户指南保持简短、平实,不出现内部术语或测试结果。更新记录时增删相关来源并保持排序,将 reviewed_revision 设为 main SHA、reviewed_at 设为当天 UTC 日期;limits 以不超过 60 词描述当前边界,不含日期或复查历史;仅在审查了 coverage 覆盖的声明时才修改 coverage。无法妥善审查的文档保持记录不变并列为仍漂移。文档应替换或删除错误句子而非追加更正,只描述当前行为,不添加日期、PR/issue 编号、测试运行或“已验证”说明;删除重复内容并链接到所属指南;不逐行复述代码或测试;一段事实只写一次;除非新功能无归属,否则不新增章节。发布前运行 git diff --stat origin/main 检查 Markdown 行数,每篇刷新文档应缩小或保持原大小,若增长需删减或在 PR 正文说明需要额外行的新行为。
验证与发布:运行 make knowledge、Python 有改动时运行 make lint、以及 pytest tests/unit/test_knowledge.py;检查器须对已刷新文档报告无漂移。提交信息为 docs(docs): refresh documentation for <version>,按仓库模板向 main 创建 PR,正文简短,包含所审查的 main SHA、刷新文档及其行数变化表、仍漂移文档及一行原因,不写逐文档叙述。最后报告 PR URL,不合并。
适用场景:需要为下一个版本统一刷新文档并同步证据记录时。限制:同一时间只允许一个刷新进行;不合并 PR;无法审查的文档需如实标记为仍漂移。