veronica
f0d2dd9920
Applies the document contract from
docs/plans/2026-08-20_stack-docs-flatten-and-alignment.md section 3, partially:
`kind` and `status` only. `parent` is deliberately held until the flatten in
section 4 lands, so that 127 documents do not have to be re-pointed by hand
when docs/fleet/NORTH_STAR.yaml moves to docs/NORTH_STAR.yaml.
Scope, measured on origin/next at 63069149:
127 live docs = all *.md under docs/ minus docs/archive/ minus docs/_old_structure/
104 stamped here
19 held operator judgement (plan section 9), worklist in the same PR
3 held the SUPERSEDED TASKS.md stamps, which cite the moving path
1 untouched docs/fleet/FLEET-DOCTRINE.md, already stamped in W1
Kinds applied: 54 guide, 34 record, 9 spec, 6 tracking, 1 projection.
Every row carries a confidence and a one-line rationale in the worklist.
Two collisions with the existing state, both flagged rather than resolved:
1. docs/README.md:150-160 already documents a front-matter convention
(title/type/audience/status/source_of_truth) with its own allowed values.
It is applied to 4 of 127 files. Its `status` vocabulary is
current|draft|deprecated|historical; the new contract's is active|superseded-by.
The key collides. This commit lets the new contract win and rewrites
`status: current` to `status: active` on those 4 files, keeping their other
legacy keys untouched. No code reads any of them: `git grep source_of_truth`
outside docs/ returns nothing. docs/README.md still prescribes the old
convention and is an operator row, so it is not edited here.
2. Two of the plan's 20 operator rows are YAML files, not markdown
(docs/fleet/examples/roster-v2.yaml, docs/openapi-tess.yaml), and the
contract's front-matter form has no defined meaning for a .yaml document.
That gap also applies to docs/fleet/NORTH_STAR.yaml, the source of truth
itself. Raised in the worklist.
A third row from the plan, docs/fleet/north-star.md, no longer exists: W1
renamed it to docs/fleet/FLEET-DOCTRINE.md.
Verification: 104/104 parse with the expected kind and status in front matter;
the check was shown to reject a wrong kind before it was trusted. The diff
removes 4 lines total, all of them `status: current`.
3.2 KiB
3.2 KiB
kind, status
| kind | status |
|---|---|
| record | active |
DOCS-IA-001 — Documentation Information Architecture
- Task: DOCS-IA-001
- Internal reference:
TASKS:DOCS-IA-001 - Objective: Codify the canonical
docs/structure and authoring rules indocs/README.mdbefore moving or rewriting existing documentation. - Scope: README contract only; no document migration in this slice.
- Approved design:
docs/plans/2026-08-10-docs-information-architecture-design.md - Implementation plan:
docs/plans/2026-08-10-docs-structure-readme.md
Plan
- Replace the starter
docs/README.mdwith the approved target tree and placement policy. - Document source-of-truth, audience-book, artifact, migration, and Obsidian link rules.
- Run focused formatting, whitespace, structure, link, and scope checks.
- Commit only
docs/README.md; preserve unrelated staged and untracked changes.
Progress
- Context inventory completed.
- Design approved by user.
- Design committed as
205cc0d. - Implementation plan written.
- Scratchpad created.
- README updated.
- Focused verification completed.
- Scoped documentation commit created (
docs: codify documentation structure).
Tests and verification
| Check | Result |
|---|---|
| Markdown formatting | PASS — pnpm exec prettier --check docs/README.md docs/plans/2026-08-10-docs-structure-readme.md docs/scratchpads/DOCS-IA-001.md |
| Whitespace validation | PASS — git diff --no-index --check for all new Markdown files |
| Required structure anchors | PASS — root controls, books, artifact directories, Obsidian, and retired mosaic-stack boundary found |
| README-only scope check | PASS — the scoped documentation commit contains only this task's README, plan, and scratchpad; unrelated changes remain outside the commit |
Risks and blockers
- Existing documentation remains under
docs/_old_structure/; this slice does not migrate it. - Existing source/tests reference legacy paths such as
docs/fleet/anddocs/federation/; those references require a later migration slice. docs/TASKS.mdhas a single-writer orchestrator policy and is intentionally not modified here.docs/GETTING_STARTED.mdis an unrelated pre-staged deletion and must remain outside this task commit.docs/.obsidian/is pre-existing untracked vault metadata and must not be modified or committed here.
Final evidence
docs/README.mdnow defines the complete target tree, placement matrix, source-of-truth policy, authoring workflow, migration policy, and Obsidian/Git link conventions.pnpm exec prettier --check docs/README.md docs/plans/2026-08-10-docs-structure-readme.md docs/scratchpads/DOCS-IA-001.mdpassed.git diff HEAD^ HEAD --checkand the staged-index whitespace check passed.- Focused structure and retired-boundary checks passed.
- All three relative Markdown links in the README resolve.
- The scoped documentation commit contains only the README, plan, and scratchpad.
- The pre-existing staged deletion of
docs/GETTING_STARTED.md, modified.mosaic/orchestrator/*files, and untrackeddocs/.obsidian/metadata remain outside the documentation commit. - Content migration, sitemap refresh, and legacy source/test path updates remain explicitly deferred to later slices.