ドキュメント一覧¶
作業に応じて以下の文書を参照してください。コマンドは、個別の指定がなければリポジトリのルートで実行します。
開発・更新¶
| 文書 | 内容 |
|---|---|
| ローカル開発とリポジトリ構成 | 起動、生成ページ、ソースの配置、本番・確認用ビルドの違い |
| コンテンツの更新 | 固定ページ、お知らせ、画像・PDFの編集と追加 |
| 表示仕様・アクセス解析 | ライト/ダーク、ロゴ、Googleアナリティクス |
| 検証手順 | 型チェック、ブラウザー検査、CSS比較、画像生成、機能別テスト |
公開・運用¶
| 文書 | 内容 |
|---|---|
| 本番デプロイの初回セットアップ | Runner、SSH鍵、NGINX、GitLab変数・タグ保護、旧構成からの移行 |
| CI/CD運用手順 | 通常の公開、検証ジョブ、失敗時の調査、切り戻し、保存容量 |
| ドキュメントサイトの公開・更新 | MkDocs、Cloudflare Pages、閲覧制限、文書用CIジョブ |
| 静的サイトのセキュリティヘッダー | 既存NGINXへの追加、CSPの段階導入、HSTS、CI/CDとの作業分担 |
| お問い合わせフォーム | 仕様・公開設定・API開発、自前版とAWS版の構築・保守 |
設計・記録¶
| 文書 | 内容 |
|---|---|
| デザイン方針 | 共通の配色・書体・操作・動きとページ別方針 |
| デザイン・移行の検証記録 | 移行・改修時点の確認結果 |
| サイト移行・公開の経緯 | 元サイトからの移行範囲、URL変更、公開の背景 |
文書の管理方針¶
- トップの
README.mdは概要と文書への案内に留めます。 - プロジェクトの文書は
docs/配下へ置きます。実装ディレクトリには説明用のMarkdownを追加しません。 - 手順、仕様、過去の確認記録を分け、同じ設定や仕様は参照リンクで共有します。新しい文書はこの一覧または分野別の入口へ追加します。
- 手順変更時は実装との対応と相対リンクを確認します。日時付きの記録は当時の結果として扱います。
.agents/skills/はエージェント用スキルの定義・同梱資料です。ツールが参照する配置を維持し、プロジェクト文書とは別に管理します。.hallmark/配下は文書整理の対象外とし、既存の配置・内容を維持します。
認証情報の実値やローカルの .env.*.local は文書へ転記しません。