[M0-DOC-01] docs/ skeleton + index - #14
Merged
Merged
Conversation
…methodology - docs/README.md: rewritten as the single index — links every AGENTS §13 section (getting-started, concepts, api, guides, debugging, benchmarks, decisions, compatibility) plus the testing conventions and related documents; explicit 'not yet written' list (DOC-001 honest status). - New section indexes: concepts/ (planned docs + interim homes, incl. the ARCH-008 coordinates topic), guides/ (milestone mapping), debugging/ (usable today + AGENTS §15 status), compatibility/ (P0 platforms per PRD §6 + CI, current formats, no migration guides yet). - docs/benchmarks/: methodology.md (normative AGENTS §12 report fields, budgets.json field->report mapping, immutable baseline-file convention, PRD §8.1 regression policy) + baselines/ (empty; first baseline m0-synthetic.md lands with M0-EXIT-01). - decisions/README.md: stale 'arrives with M0-DOC-01' note replaced (ADRs 0001-0004 remain indexed). - Root README.md: docs pointer now links docs/README.md; ADR list corrected to 0001-0004 (DOC-003 stale-doc fix, same change). Verify: repo-wide dead-link check over all 49 *.md files — 104 internal links, zero dead; every section linked from docs/README.md; decisions index references ADR 0001-0003 (+0004); ctest 32/32 green on the existing build tree (docs-only change, no build impact).
…s, board + change log - M0-foundations.md: M0-DOC-01 marked done with the house-style Decision (2026-09-13), Verify (manual per the step's 'CI or manual' clause: index coverage, 49-file dead-link check with 0 dead links, ADR refs, budgets.json mapping, ctest 32/32), and Size notes. - roadmap/README.md: progress board M0 20->21 done (of 22), total 20->21; change-log line for M0-DOC-01 (commit 972090d).
ci-pull.yml run 34749554015 on PR #14: all 7 executed jobs green (linux-gcc, linux-clang, linux-asan+UBSan, linux-tsan, include-lint, api-manifest, detcheck); macOS/Windows skipped (label-gated, PRD §14 cadence).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements roadmap step M0-DOC-01 (
roadmap/M0-foundations.md): the full AGENTS §13docs/tree plus the benchmark methodology doc.Changes (docs only — no code)
docs/README.md— rewritten as the single index: links every AGENTS §13 section (getting-started, concepts, api, guides, debugging, benchmarks, decisions, compatibility) plus the testing conventions and related documents, with an explicit "not yet written" status list (DOC-001).docs/concepts/README.md— planned concept documents (coordinates/ARCH-008, determinism, lifecycle, threading, architecture) with today's interim homes.docs/guides/README.md— milestone mapping for the task-oriented guides.docs/debugging/README.md— what is usable today (logging, budget harness, detcheck, sanitizer builds, test seeds) + AGENTS §15 status.docs/compatibility/README.md— P0 platform/compiler table (PRD §6, CI matrix), current machine-readable formats (budgets.jsonv1,laige-api.jsonv1,deps.lock), migration status (none yet — pre-1.0).docs/benchmarks/—methodology.md(normative: the AGENTS §12 report-field table, thebudgets.jsonfield→report mapping, the immutable baseline-file convention, the PRD §8.1 regression policy incl. the >10% band, hard-zero budgets, and loudNO_SAMPLES) +baselines/(empty; the first baselinem0-synthetic.mdlands with M0-EXIT-01).docs/decisions/README.md— stale "arrives with M0-DOC-01" note replaced; ADRs 0001–0004 remain indexed.README.md(root) — docs line now points todocs/README.md; ADR list corrected to 0001–0004 (DOC-003 stale-doc fix in the same change).M0-DOC-01checked with Decision/Verify/Size notes; progress board M0 20→21; change-log line.Verification
*.mdfiles (104 internal links): 0 dead links — the step's Verify clause allows "checked in CI or manual"; scope is docs-only, so no CI job was added.docs/README.mdlinks every section; the decisions index references ADR 0001, 0002, 0003 (the three M0-DEC ADRs) and 0004.budgets.jsonentries map field-by-field onto the methodology's report table; the stable 4-line report format stays sourced fromdocs/api/budget_harness.md(referenced, not duplicated).buildtree re-ranctest32/32 green; the full P0 CI lane will run on this PR (ci-pull.yml).