mcpField
T
tenzir-update-docs

tenzir-update-docs

github.com/tenzir開発368 回インストール1 日前に更新
リポジトリ

tenzir-update-docs について

Tenzirの独立した`tenzir/content`リポジトリで、ドキュメント変更を調整するワークフロースキルです。ブランチ作成、執筆とチェック、プルリクエストの作成、コードPRとの相互リンクを案内します。

主な機能

  1. 01ドキュメント用ブランチの準備
  2. 02リポジトリの執筆規約に準拠
  3. 03利用可能なドキュメントチェックの実行
  4. 04プルリクエストの作成と相互リンク
  5. 05automergeラベルの付与
  6. 06ページ構成と参照の確認

活用シーン

  1. 01コード変更に合わせた製品ドキュメントの更新
  2. 02相互に関連付けたドキュメントPRとコードPRの準備
  3. 03PR提出前のドキュメント検証

インストール

コマンドをコピーしてターミナルで実行します。

$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/ にあります。

ワークフロー

ドキュメントの変更はすべて、tenzir/content のクローンである .docs/ で行います。 .docs/ が存在しない場合はクローンします。それ以外の場合は、origin から最新の参照を取得します。

  1. 親リポジトリのブランチ名に合わせて、.docs/ にトピックブランチを作成するか、チェックアウトします。
  2. リポジトリ独自のドキュメント作成ガイドラインと規約に従って、website/src/content/docs/ 以下のコンテンツを更新します（まず website/README.md を読みます）。
  3. リポジトリに関連するドキュメントチェックが用意されている場合は実行します（website/ で bun run check）。
  4. .docs/ から tenzir/content のプルリクエストを作成します。
  5. 1つの共通の簡潔なフッターパターンを使って、プルリクエスト同士を相互リンクします。
    • ドキュメントの PR では、コードの PR へのリンクと同じ Linear の課題を記載した、末尾の <sub>...</sub> フッターブロックを追加します。例：⚙️ Code PR: tenzir/tenzir#6048<br>🎫 References TNZ-150, TNZ-151。
    • コードの PR では、末尾の <sub>...</sub> フッターに 📚 Docs PR: tenzir/content#261 を追加するか、既存のフッターに追記します。
    • 両方向の PR リンクには、完全な URL ではなく、tenzir/tenzir#6048 や tenzir/content#261 のような GitHub の短縮表記を使います。特定のコメントなど、短縮表記で表現できない詳細リンクに限り、完全な URL を使います。
    • フッターがすでにある場合は、2つ目のフッターを作成せず、<br> 区切りの行を追加します。
  6. ドキュメントの PR に automerge ラベルを付けます。これにより、リンク先のコード PR がマージされ、ドキュメントチェックに合格した後、コンパニオン PR が CI によって squash merge できる状態になります。
  7. 変更内容を要約し、今後の作業があれば記載します。

ブランチ

可能な限り、.docs/ のブランチ名をコードブランチに合わせます。 コードの変更が複数のリポジトリにまたがる場合は、コードブランチを命名と相互リンクの基準にします。

PR の相互リンク形式

各 PR の説明の末尾にある簡潔なフッターで、ドキュメントとコードの PR を相互リンクします。ドキュメント PR のフッターでは、references などのクローズしない語を使って、同じ Linear の課題を記載します。これにより、コンパニオンとなるドキュメント PR が課題を独立して移動させることを防ぎます。複数の課題が同じ関係にある場合は、簡潔なフッターになるよう、1つのマジックワードの後に1行で列挙します。関係が異なる場合に限り、行を分けます。

ドキュメント 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 対応