ソースコードの内容を読み取り、対応するドキュメント(index.md)にセクションを追記する。ユーザーが新しいサンプルコードを追加した際にドキュメントを自動生成するために使用する。
ソースコードファイルのパスを受け取り、対応する章のドキュメント(index.md)に新しいセクションを追記する。
$ARGUMENTS のファイルを読み込み、内容を把握するpackages/@ai-suburi/core/chapter3/...)から章番号を特定し、packages/@ai-suburi/docs/docs/chapter<N>/index.md を読む## <セクション番号>. <セクションタイトル>
<概要説明(2〜3文)>
### <サブ見出し(必要に応じて)>
<詳細説明やテーブル>
### <サンプルの説明見出し>
このサンプルでは以下を行います。
- ポイント1
- ポイント2
- ...
\```typescript title="chapter<N>/<ファイル名>.ts"
<ソースコード全文>
\```
**実行方法:**
\```bash
pnpm tsx chapter<N>/<ファイル名>.ts
\```
新しい章やセクションとして md ファイルを新規作成した場合は、フッターにもリンクを追加する。
packages/@ai-suburi/docs/docusaurus.config.ts を開くfooter.links 配列の中から、対応するカテゴリの items を探す{
label: '<Chapter N: ページタイトル>',
to: '/docs/<カテゴリ>/<ファイル名(拡張子なし)>',
},
例: docs/ai-agent-practice/chapter4.md を追加した場合、「AI エージェント実践入門」カテゴリの items 末尾に以下を追加する。
{
label: 'Chapter 4: ヘルプデスク担当者を支援するAIエージェントの実装',
to: '/docs/ai-agent-practice/chapter4',
},
test3-8-xxx.ts → セクション 3-8)| セクション | 内容 |)にも新しいセクションの行を追加する--- 区切り線の前(参考文献セクションの直前)に新しいセクションを挿入するtest3-11.ts)、既存の命名規則(test<章>-<番号>-<説明>.ts)に合わせてリネームする(例: test3-11.ts → test3-11-text-to-sql.ts)。リネーム後はドキュメント内の参照(コードブロックの title や実行方法の pnpm tsx コマンド)もすべて更新する