mcpField
T
tenzir-update-docs

tenzir-update-docs

github.com/tenzir开发368 次安装1 天前更新
代码仓库

关于 tenzir-update-docs

用于协调 Tenzir 独立 `tenzir/content` 仓库文档变更的工作流 Skill。它指导创建分支、撰写和检查文档、提交拉取请求，并与代码 PR 互相链接。

主要功能

  1. 01设置文档分支
  2. 02遵循仓库写作规范
  3. 03运行可用的文档检查
  4. 04创建并互链拉取请求
  5. 05添加 automerge 标签
  6. 06检查页面结构和引用

适用场景

  1. 01随代码变更更新产品文档
  2. 02准备互相关联的文档与代码 PR
  3. 03提交 PR 前验证文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tenzir/skills --skill tenzir-update-docs

安装后在 Claude Code 中输入/tenzir-update-docs确认已加载。

详细介绍

更新文档

处理文档变更相关的操作流程。文档位于 tenzir/content 仓库（该仓库也托管 tenzir.com 网站）的 website/src/content/docs/ 目录下。

工作流

所有文档变更都在 .docs/ 中进行；该目录是 tenzir/content 的克隆。如果 .docs 不存在，请克隆该仓库；否则从 origin 获取最新引用。

  1. 在 .docs/ 中创建或检出一个与父仓库分支名称一致的主题分支。
  2. 根据仓库自身的文档指南和规范，在 website/src/content/docs/ 下编写内容更新（请先阅读 website/README.md）。
  3. 如果仓库提供相关文档检查，请运行（在 website/ 中运行 bun run check）。
  4. 从 .docs/ 提交 tenzir/content 拉取请求。
  5. 使用同一简洁页脚格式交叉链接两个拉取请求：
    • 在文档 PR 中，追加一个最终的 <sub>...</sub> 页脚块，链接代码 PR 并引用相同的 Linear issue，例如： ⚙️ Code PR: tenzir/tenzir#6048<br>🎫 References TNZ-150, TNZ-151。
    • 在代码 PR 中，在最终的 <sub>...</sub> 页脚中追加或扩展以下内容： 📚 Docs PR: tenzir/content#261。
    • 两个方向的 PR 链接都使用 GitHub 简写，例如 tenzir/tenzir#6048 或 tenzir/content#261，不要使用完整 URL。仅在简写无法表示深层链接（例如某条具体评论）时使用完整 URL。
    • 如果页脚已存在，请添加另一个以 <br> 分隔的行，而不是新建第二个页脚。
  6. 为文档 PR 添加 automerge 标签。代码 PR 合并且文档检查通过后，该标签会将配套 PR 标记为可由 CI 执行 squash 合并。
  7. 总结变更内容，并说明后续工作（如有）。

分支

尽可能让 .docs/ 分支名称与代码分支保持一致。 如果代码变更涉及多个仓库，则以代码分支作为命名和交叉链接的依据。

PR 交叉链接格式

在每个 PR 描述的末尾使用简洁页脚，放置文档与代码的交叉链接。在文档 PR 页脚中，用 references 这类非关闭 issue 的词语引用相同的 Linear issue，避免配套文档 PR 独立推动 issue 状态。当多个 issue 具有相同的关系时，在同一行的一个 magic word 后列出这些 issue，以保持页脚简洁。只有关系不同时才分行。

文档 PR 示例：

<sub>
⚙️ Code PR: tenzir/tenzir#1234<br>
🎫 References TNZ-150, TNZ-151
</sub>

代码 PR 示例：

<sub>
📚 Docs PR: tenzir/content#261<br>
✅ Closes TNZ-150, TNZ-151<br>
📎 Related: tenzir/tenzir#5999
</sub>

交叉检查

提交文档 PR 前：

  1. 确认变更后的页面仍符合其 Diataxis 分类。
  2. 检查附近页面和“另请参阅”链接，确认是否需要后续修改。“另请参阅”仅用于相关指南、教程、集成和更广泛的参考内容。在相关位置内联链接到具体算子，不要将它们列在“另请参阅”中。
  3. 确保代码示例、路径和 UI 标签与当前产品行为一致。

评论

支持 Markdown