指定された章のドキュメント(index.md)を見直し、ソースコードとの差分チェック・内容の加筆修正・構成の整合性確認を行う。
指定された章のドキュメント(index.md)を包括的にレビューし、問題があれば加筆・修正を行う。
$ARGUMENTS から章番号またはドキュメントパスを判定する
chapter3 や 3 → packages/@ai-suburi/docs/docs/chapter3/index.mdpackages/@ai-suburi/core/chapter3/)index.md)を読み込む.ts ファイルを Glob で列挙するドキュメント内のコードブロックと実際のソースコードを行単位で比較し、以下を確認する:
差分があった場合: ドキュメント側のコードブロックを最新のソースコードで置き換える。
以下の項目を確認し、不整合があれば修正する:
| セクション | 内容 | テーブルに、実際に存在するセクション見出しがすべて含まれているか確認する。
:::note この章で学ぶこと ブロック内の箇条書きが、実際のセクション内容を網羅しているか確認する。
:::info 前提条件 ブロックに、ソースコードが依存する環境変数やセットアップが正しく記載されているか確認する。
process.env.* を Grep で検索し、記載漏れがないか確認するMarkdown lint ルール(MD024)に違反する重複見出しがないか確認する。
ソースコードディレクトリに存在するが、ドキュメントにセクションがないファイルを検出する。 → 検出した場合はユーザーに報告し、追記が必要か確認する。
各セクションの説明文について以下を確認する:
発見した問題をすべて Edit ツールで修正する。修正内容は以下のカテゴリ別にまとめて報告する:
title 属性は chapter<N>/<ファイル名>.ts の形式を維持するレビュー完了後、以下の形式でサマリーを出力する:
## レビュー結果サマリー
### 修正した項目
- [ 修正内容1 ]
- [ 修正内容2 ]
- ...
### 問題なしの項目
- コードブロック: ✅ / ⚠️
- 概要テーブル: ✅ / ⚠️
- 学ぶことリスト: ✅ / ⚠️
- 前提条件: ✅ / ⚠️
- 見出し一意性: ✅ / ⚠️
- セクション網羅性: ✅ / ⚠️
### ユーザーへの確認事項(ある場合)
- [ 確認事項 ]