ドキュメント更新ガイド¶

このページでは、ドキュメントを更新する際のワークフローを説明します。

前提条件¶

• uvがインストールされていること
• リポジトリをクローン済みであること

ドキュメントの更新方法¶

1. 依存関係のインストール¶

初回のみ、開発用依存関係をインストールします。

uv sync --extra dev

2. ブランチを作成¶

git switch -c features/update-documentation

3. ドキュメントを編集¶

docs/配下のMarkdownファイルを編集します。

執筆時のガイドラインは執筆ガイドを参照してください。

4. ローカルでプレビュー¶

uv run zensical serve

ブラウザでhttp://127.0.0.1:8000を開いて確認します。

5. テストを実行（必須）¶

プルリクエストを作成する前に、必ずテストを実行 してください。

uv run pytest

テストでは以下を検証します：

• 画像リンク切れがないか
• Markdownリンク切れがないか
• 使用されていない画像ファイル（デッドファイル）がないか

6. コミット・プッシュ¶

git add .
git commit -m "docs: update documentation"
git push origin features/update-documentation

7. プルリクエストを作成¶

GitHubでプルリクエストを作成し、レビューを依頼します。

補足¶

ローカルでビルドする場合¶

uv run zensical build

ビルド結果は site/ ディレクトリに出力されます。

テストが失敗した場合¶

エラーメッセージを確認して問題を修正してください。よくある原因は以下の通りです：

• リンク切れ（ファイルパスの誤り）
• 使用されていない画像ファイルが残っている
• 画像ファイルが存在しない