SuperAPI AI 工具集

sync-docs

智能体与模型

查看项目

更新于 10-16 01:33

技能介绍

用途:在变量或功能变更后,同步 kube-hetzner 项目的多处文档,避免文档与源码脱节。核心是确保 variables.tf(变量唯一来源)与 docs/llms.md、kube.tf.example、README 等文件保持一致。

主要能力:通过比较 variables.tf 中的变量名与文档中代码格式变量名,识别未记录变量;按格式补写 docs/llms.md;更新 kube.tf.example 中的示例注释;按需更新 README 的功能描述。资料还列出多组需同步的文件面,例如 Tailscale、Cloudflare Zero Trust、Cilium Gateway API、registry mirror、v2→v3 迁移与 SELinux 变更等。

使用方式:以 /sync-docs 调用。工作流为:从 variables.tf 提取变量、与 docs/llms.md 比较、找出缺口、更新 docs/llms.md、更新 kube.tf.example、必要时更新 README、最后验证一致性。资料给出命令示例,如 rg -o '^variable "[^"]+"' variables.tf | cut -d'"' -f2 | sort -u,以及 comm -23 比较未记录变量。同步后运行 terraform fmt -recursive,必要时提交信息为 docs: sync documentation with variables.tf。

适用场景:修改 variables.tf、新增或重命名变量、调整默认值、涉及版本迁移、SELinux 策略、Tailscale 传输、Gateway API 等文档面变更时。

限制:该技能不编造功能,需配合 terraform-docs、生成站点契约测试与 /test-changes 验证;README 需保持在其契约长度限制内,调试与高级内容应放入对应指南而非膨胀 README。