SuperAPI AI 工具集

dify-docs-release-sync

写作与研究

查看项目

更新于 10-15 23:48

技能介绍

用途:在准备 Dify 发版文档更新时,对比两个版本引用之间的代码变更,识别文档影响,生成结构化报告,并在用户批准后执行更新。用户需提供两个版本引用(如 v1.13.2 与 v1.13.3,或 v1.13.2 与 main),未提供时应主动询问。

主要能力:分三条轨道——API 参考(对应 dify-docs-api-reference)、帮助文档(dify-docs-guides)、环境变量(dify-docs-env-vars)。流程为:对比版本间变更文件、获取 PR 上下文、按文档影响分类、生成报告并停止等待用户批准,再执行更新。

使用方式:在 Dify 代码库中运行 git fetch --tags origin,再用 git diff <from>..<to> --stat 与 git log <from>..<to> --oneline --grep="(#" 获取变更;用 gh pr list --repo langgenius/dify-docs 交叉检查已有文档 PR,避免重复。API 参考按控制器路径确定性映射到对应 spec;帮助文档按源码路径启发式映射;环境变量按 docker/.env.example、api/configs、docker-compose.yaml 等检测。执行前需 git checkout <to> 切换到目标版本。API 与帮助文档的翻译在 PR 推送时自动完成;environments.mdx 在翻译忽略列表中,需手动更新 ZH/JA。

适用场景:Dify 发版后的文档同步、预发布对比、环境变量与 UI i18n 词条变更检查。

限制:版本引用必须由用户提供;报告生成后必须停止等待批准;里程碑方式可能遗漏未标记 PR,优先用标签对比;路径映射为启发式,需结合 PR 描述确认;不得预先过滤 diff 路径列表。