2026-08-08 開発者ドキュメントサイトの導入(Issue #12)
- 課題: READMEにセットアップ・検証・アーキテクチャ・コントリビューションが一枚にまとまっており、初めて参加する人が順番に学ぶ導線になっていなかった。
- 決定: VitePressで静的サイトを生成し、GitHub Pages(
https://henkaku-center.github.io/initiation/)で公開する。base pathは/initiation/。 - 配置: VitePressのsrcDirを既存の
docs/にする。開発計画・決定事項ログ・Runbookをそのままリファレンスとして公開でき、正本を二重に持たずに済むため。 - 除外:
docs/superpowers/**はサイトから除外する。実装計画は分量が大きく、読み進める導線に載せない。リポジトリ上のファイルとしては従来どおり参照できる。 - READMEとの関係: READMEは概要と要点をまとめた入口として残し、手順の詳しい説明はサイトを正本とする。READMEからサイトへの導線を追加した。矛盾する記述を置かないことを維持の条件とする。
- CIの分離: アプリ本体のCI(#7)とはワークフローファイルを分け(
.github/workflows/docs.yml)、docs関連の変更時のみ実行する。同一ファイルを編集しないためPR間の衝突も避けられる。VitePressはリンク切れでビルドが失敗するため、docs:buildがリンク検証を兼ねる。 - 検索: 外部サービスやAPIキーを必要としないVitePressのlocal searchを使い、日本語UIの文言を設定する。
- 既知の脆弱性: VitePress 1.6.4 が依存する vite / esbuild に開発サーバー向けの脆弱性(GHSA-67mh-4wv8-2f99 ほか)がある。いずれも
vitepress devを動かしている間に限られ、ビルド後の静的サイトには影響しない。VitePressはdevDependencyで、安定版に修正版がまだない(2.xはalphaのみ)ため、現時点では受け入れる。安定版が出た時点で更新する。