マニュアルを差分更新するには
このページでは、annai(ソースコードからユーザー向けマニュアルを自動生成するツール)を使い、前回の生成以降に変更があったページだけを再生成します。
手順
-
ターミナル(コマンドを入力する画面)を開き、annai.config.json があるプロジェクトのフォルダへ移動します。
-
以下のコマンドを入力し、キーボードの Enter(実行)キーを押します。
annai gen --mode incremental -
処理が完了するまで待ちます。annai が前回の生成時点からの変更ファイルを検出し、影響を受けるページだけを再生成します。
-
ターミナルに「完了」と表示されたら、更新されたページの一覧を確認します。
ここまでの手順が完了すると、変更に関連するページのみが最新の内容に更新された状態になります。
警告
「変更ファイルがありません」と表示される場合は、ソースコードの変更が Git(ソースコードの変更履歴を管理するツール)にコミット(変更の記録)されているか確認します。
コミットされていない変更は検出されません。
「認証が切れています」というメッセージが表示された場合は、claude login を実行して再認証した後、同じコマンドを再度実行します。