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`.
61 lines
3.2 KiB
Markdown
61 lines
3.2 KiB
Markdown
---
|
|
kind: spec
|
|
status: active
|
|
---
|
|
|
|
# Documentation Catalog and Truth Audit Plan
|
|
|
|
**Task:** DOCS-IA-002
|
|
**Internal reference:** `TASKS:DOCS-IA-002`
|
|
**Goal:** Catalog the existing Mosaic Stack documentation, identify its intended destination in the new structure, and audit validity/truthfulness against repository evidence before moving or rewriting content.
|
|
|
|
## Scope
|
|
|
|
- Current root-level documentation and newly established structure files.
|
|
- All Markdown and relevant YAML/API artifacts under `docs/_old_structure/`.
|
|
- Repository references from source, tests, scripts, guides, and root README files.
|
|
- Static truth checks for paths, commands, package names, environment variables, API artifacts, and explicit document status.
|
|
|
|
## Non-goals
|
|
|
|
- Do not move, delete, or rewrite documentation.
|
|
- Do not decide product requirements that belong in `docs/PRD.md`.
|
|
- Do not mark a claim true solely because it appears in a document.
|
|
- Do not modify active `docs/TASKS.md` because it has a single-writer orchestrator policy.
|
|
|
|
## Parallel discovery lanes
|
|
|
|
1. **File catalog:** path, title, type, size, line count, current/archive location, last repository change.
|
|
2. **Navigation audit:** Markdown and Obsidian links, target resolution, broken-link clusters, source references.
|
|
3. **Code-surface audit:** package names, scripts, entry points, referenced docs, paths used by tests and source.
|
|
4. **Truth triage:** compare current claims against executable code/config/tests and label evidence strength.
|
|
|
|
Parallel lanes produce findings only. The coordinator reconciles them into one report so truth labels remain consistent.
|
|
|
|
## Evidence statuses
|
|
|
|
- `verified`: directly supported by current source/config/tests or a reproducible command.
|
|
- `partially-verified`: some claims are supported, but the page contains unverified or time-sensitive claims.
|
|
- `contradicted`: current repository evidence conflicts with a material claim.
|
|
- `stale`: formerly meaningful but no longer aligned with current paths, APIs, or state.
|
|
- `historical`: intentionally retained record of past state; not a current instruction.
|
|
- `draft`: normative proposal or requirement, not a statement of shipped behavior.
|
|
- `unverified`: not yet checked or insufficient evidence exists.
|
|
- `incomplete`: empty or structurally insufficient for its stated role.
|
|
|
|
## Deliverables
|
|
|
|
- `docs/reports/documentation/2026-08-10-docs-catalog-audit.md` — human-readable catalog, findings, evidence, and migration recommendations.
|
|
- `docs/scratchpads/DOCS-IA-002-catalog-audit.md` — task progress and command evidence.
|
|
|
|
A machine-readable intermediate inventory may remain under `/tmp`; it is not canonical unless explicitly copied into the report.
|
|
|
|
## Acceptance criteria
|
|
|
|
- Every current documentation file and every archived documentation file is counted and assigned a preliminary disposition.
|
|
- Broken internal links and repository references are enumerated with evidence.
|
|
- Truth labels distinguish current behavior, normative intent, historical evidence, and unresolved claims.
|
|
- High-risk contradictions and source/test dependencies are called out before any migration.
|
|
- The report recommends migration order and identifies pages requiring human/product-owner validation.
|
|
- No existing documentation or unrelated working-tree state is modified.
|