docs(options): README tables reconciled + permanent option-docs check (item 6a)
All checks were successful
Check / eval (push) Successful in 2m59s

Slice (a) of the docs review: 9 undocumented nomarchy.* options got
README rows or inline .leaf mentions (autoTimezone, camera IR-hide,
intel.guc, amd.pstate/vaapi, package, system.stateFile, restic.paths).
The diff is now a flake check: option names are eval-walked from the
four option-declaring modules (config halves stay lazy) and compared
to the tables by tools/check-option-docs.py — undocumented options and
stale table rows both fail. Negative-tested against the pre-fix README
(reports exactly the 9 gaps). Item 6 split into slices a–d in BACKLOG.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Bernardo Magri
2026-07-04 19:31:20 +01:00
parent 9cd6f5e30c
commit 56f1cc3fa9
6 changed files with 145 additions and 16 deletions

View File

@@ -22,19 +22,21 @@ next, in what order*.
## NOW
*Items 2127: real-hardware QA findings from the Latitude 5410
(Bernardo, 2026-07-04) — bugs found on metal outrank the queue.*
### 6. Full docs review & restructure
ROADMAP § Full docs review. The roadmap/backlog split is done (this
file); remaining: reconcile every README option table against the live
`nomarchy.*` surface; drift pass over docs/OVERRIDES.md, docs/TESTING.md,
templates/downstream/README.md; read the install/first-run story end to
end; add a short **recovery runbook** (desktop won't start → boot an
older generation / `nomarchy-snapshots` / greetd journal — the pieces
exist, the story isn't written). Site-vs-markdown is a Decision (below).
**Verify:** V0 + a mechanical option-surface diff (eval the options,
compare to the tables — consider making that a permanent check).
### 6. Full docs review & restructure — sliced, one slice per iteration
ROADMAP § Full docs review. Done: the roadmap/backlog split (this file);
slice (a) option-surface reconcile — README tables fixed (9 gaps) and
the diff made permanent as the `option-docs` flake check (eval-walked
surface vs tables, catches stale rows too). Remaining slices:
- **(b) drift pass** over docs/OVERRIDES.md, docs/TESTING.md,
templates/downstream/README.md — read each against the current tree,
fix what lies.
- **(c) install/first-run story** read end to end (README install §§ +
template README as one narrative; fix the seams).
- **(d) recovery runbook** — short doc: desktop won't start → boot an
older generation / `nomarchy-snapshots` / greetd journal. The pieces
exist, the story isn't written.
Site-vs-markdown is a Decision (below). **Verify:** V0 per slice; (b)/(c)
against the live tree, not memory.
## NEXT