資料とリポジトリの参照地図
1. 資料の優先順位
introduction/index.mdから目的に合う資料を選ぶ。必要な場合だけintroduction/manifest.jsonを補助的に参照する。introduction/core/の背景・設計・確認資料を読む。introduction/project_context.xmlは機械的な補助情報として必要な場合だけ参照する。- 利用者向けの挙動は
README.md、docs/ja/、docs/en/で補う。 - 実装保証、安全性、保存、配布物について強い客観的主張をする場合は、公開リポジトリの
src/、設定、tests/、検査結果を追加確認する。
| 質問・変更の領域 | まず読む資料 | 一次資料・確認範囲 |
|---|---|---|
| 導入、更新、Lite版 | core/user_guidance_reference.md | README.md、docs/ja/Getting_Started.md |
| カスタマイズ、操作、画面 | core/user_guidance_reference.md、core/ui_concepts.md | docs/ja/Using_the_App.md、src/help/、設定の読込・保存コード |
| 保存、stage、復元、データ形式 | core/file_formats.md、core/data_schemas.md | docs/ja/Save_and_Recovery.md、src/file_output/、src/clrop/、関連テスト |
| 安全性、外部通信、無音 | core/safety_and_nonnegotiables.md、core/troubleshooting_quick.md | 対象ソース、設定、検査結果。一般警告音は未解消の既知問題として扱う |
| コード構造・変更 | core/architecture_layers.md、core/code_symbol_index.md、core/ai_guardrails.md | src/、呼び出し元、tests/ |
| 公開・ライセンス・配布 | core/documentation_contract.md | LICENSE.md、LICENSES_INDEX.md、THIRD_PARTY_NOTICES.md、公開用設定 |
2. リポジトリと公開先の役割
| 場所 | 役割 | 確認時の注意 |
|---|---|---|
OPEN_PDF-Note-Workspace の main | ソース、テスト、利用者向け文書、公開説明資料を含む公開snapshot | 実装の確認には、該当するソース・テスト・公開資料を読む |
| GitHub Pages | site/github/ が生成する文書ポータル | introduction/index.md、公開済み一次資料と事前整理した説明を読む入口 |
| Cloudflare Pages | 紹介ページ | 公開説明資料の正本を複製せず、GitHub Pagesの入口を案内する |
GitHub Pagesからの回答では、Pagesにないソースやテストを読んだように装わない。実装確認が必要なら、公開リポジトリの該当資料を確認するか、未確認であることを明示する。
3. 検索と経路選択
- 質問意図から候補を絞るときは
core/semantic_search_index.jsonのintent、keywords、target_nodeを使う。 - 実際に読む資料の集合は
introduction/manifest.jsonのroutesを正本とする。 - 索引にない質問は、全資料を無差別に要約せず、近い経路を選んでから一次資料とソースの所在を確認する。
4. 開発・公開時の確認
- コード変更では、対象、呼び出し元、関連テストを確認する。保存・注釈・出力の変更では、読み込み、編集、stage、自動保存、統合保存、再読込、undo/redo、バックアップ・復元、export、失敗時を確認範囲に含める。
- GitHub Pagesを更新する場合は、
site/github/documentation_portal_allowlist.jsonで公開対象を確認し、生成・検査を実行する。紹介ページは含めない。 - Cloudflare Pagesを更新する場合は、紹介ページ用の公開ファイルだけを対象とし、公開説明資料を複製しない。
- 問題報告・セキュリティ報告は
core/user_guidance_reference.mdと.github/SECURITY.mdを確認する。利用可能な連絡手段を推測しない。
EVIDENCE:
introduction/index.mdintroduction/manifest.jsonintroduction/core/documentation_contract.mdintroduction/core/user_guidance_reference.mddocs/ja/とdocs/en/site/README.mdsite/github/documentation_portal_allowlist.json- Cloudflare Pagesの紹介ページ