8750186e55
Phase 26-H 完了内容: ✅ JoinIR 型定義実装（src/mir/join_ir.rs） ✅ MIR → JoinIR 自動変換実装（lower_min_loop_to_joinir） ✅ 自動変換テスト実装（mir_joinir_min_auto_lowering） ✅ PHI/Loop箱 → JoinIR 移行対応表追加（loopform_ssot.md） ドキュメント更新: - Phase 27 JoinIR タスク計画追加 - Phase 26-H タスク完了記録 - 各種 README 更新（進捗反映） - CURRENT_TASK.md 更新 コミット統計: $(git status --short | wc -l) files changed 次のステップ: Phase 27 一般化 MIR → JoinIR 変換
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Contributing Docs — Small, Linked, 3‑Layer
|
||
|
||
Status: Stable | Updated: 2025‑09‑21 | Scope: Docs structure/policy
|
||
|
||
TL;DR
|
||
- Keep docs small. Use 3 layers: Overview → Reference → Details.
|
||
- No duplication: overview links to the single canonical reference.
|
||
- Every page shows Status/Updated/Scope and has a short summary.
|
||
|
||
Layers
|
||
- Overview (design one‑pager)
|
||
- What/Why/How in bullets, ≤1 page; links to Reference/Details/Guides.
|
||
- Reference (docs/reference/)
|
||
- Canonical spec: invariants, API, acceptance rules. Precise and stable.
|
||
- Details (docs/design/ or docs/development/…)
|
||
- Background, alternatives, rationale. Optional; link from overview only.
|
||
|
||
Authoring Rules
|
||
- One canonical spec per topic (in reference/). Others must link to it.
|
||
- Each directory has a README.md that points to its key one‑pagers.
|
||
- Cross‑links go under “See also” (≤3 items, relative paths).
|
||
|
||
One‑pager Template
|
||
- Title / Status / Updated / Scope
|
||
- TL;DR (3–5 lines)
|
||
- What (spec bullets)
|
||
- How (integration points, ownership boundaries)
|
||
- Links (Reference / Details / Guides)
|
||
- Notes (constraints / future work)
|
||
|
||
Examples
|
||
- Using→Loader overview: docs/development/design/legacy/using-loader-integration.md
|
||
- Mini‑VM roadmap: docs/private/roadmap2/phases/phase-17-loopform-selfhost/MINI_VM_ROADMAP.md
|