Dev Docs のデプロイ
TIP
このドキュメントでは、Dev Docs(開発者向けドキュメント)のデプロイ先とアクセス方法について説明します。
デプロイ先
Dev Docs は Cloudflare Pages を使用してデプロイされています。
アクセス可能なドメイン
以下の2つのドメインでアクセスできます:
- カスタムドメイン: https://dev-docs.zipunk.com/
- Cloudflare Pages デフォルトドメイン: https://4c07073e.knowledge-datasource.pages.dev/
デプロイフロー
knowledge-datasourceリポジトリの main ブランチにマージすると、自動的に Cloudflare Pages でビルドとデプロイが実行されます- ビルドが成功すると、上記の URL で更新されたドキュメントが公開されます
注意
main ブランチにマージすると即座にデプロイされるため、マージ前に内容を十分に確認してください。
アクセス制限
Dev Docs には Cloudflare Access を用いたアクセス制限がかかっています。
アクセス権限
- ジパンクドメイン(@zipunk.com)を持つユーザーのみがアクセス可能です
- 初回アクセス時に、メールアドレスによる認証が求められます
アクセス方法
- 上記いずれかの URL にアクセス
- Cloudflare Access のログイン画面が表示される
@zipunk.comのメールアドレスを入力- メールで送られてくる認証リンクをクリック
- Dev Docs にアクセス可能になる
ドキュメントの更新方法
Dev Docs を更新する場合は、以下の手順に従ってください:
knowledge-datasourceリポジトリで作業ブランチを作成data/dev_docs/配下のドキュメントを編集- 新規ドキュメントを追加する場合は、
data/dev_docs/.vitepress/config.mtsのサイドバー設定も更新 - プルリクエストを作成し、レビューを受ける
- main ブランチにマージすると、自動的にデプロイされる
詳細な記法ガイドについては、CLAUDE.md の dev_docs セクションを参照してください。