ドキュメントサイトのデプロイとローカル閲覧

ドキュメントサイトは Cloudflare Pages の waste-link-docs（https://docs.waste-link.app/）で配信します。Cloudflare Access の One-time PIN で保護され、社内メンバーだけが閲覧できます。

自動デプロイ

.github/workflows/docs-deploy.yml が develop への push で起動し、次の paths に変更があると MkDocs を strict ビルドして Cloudflare Pages へデプロイします。

• docs/**
• mkdocs.yml
• .github/workflows/docs-deploy.yml

デプロイ先のプロジェクトは waste-link-docs、ブランチ指定は main です。CLOUDFLARE_API_TOKEN と CLOUDFLARE_ACCOUNT_ID が未設定の間はビルドだけ実行し、デプロイを skip します。

.github/workflows/docs.yml は PR 時の検証用です。次の paths を対象に mkdocs build --strict（および Mermaid 構文検証）を実行します。

• docs/**
• mkdocs.yml
• package.json
• pnpm-lock.yaml
• scripts/validate-mermaid.mjs
• .github/workflows/docs.yml

ローカル閲覧

.venv はリポジトリ外または .gitignore 済みの場所に作成します。

python3 -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt
mkdocs serve                    # → http://127.0.0.1:8000

ワンショットの検証は次のコマンドです。

mkdocs build --strict

不採用・経緯

旧方針では公開デプロイを行わず、将来 GitHub Private Pages を使う想定でした。現在は Cloudflare Pages + Cloudflare Access を採用しているため、GitHub Private Pages の計画は不採用です。