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

@@ -17,6 +17,23 @@ Template:
---
## 2026-07-04 — docs slice (a): option-surface reconcile (iteration #13, item 6a)
- **Task:** BACKLOG NOW#6, first slice — README tables vs live options.
- **Did:** split item 6 into slices (ad) in BACKLOG. Reconciled: 9
undocumented options (autoTimezone.enable!, camera.hideIrSensor +
irMatch!, intel.guc, amd.pstate/vaapi, package, system.stateFile,
restic.paths) — rows/inline mentions added, no stale rows found.
Made it permanent: `checks.option-docs` — flake.nix eval-walks option
names from the 4 option files (config halves stay lazy; dummy args)
→ tools/check-option-docs.py enforces row-or-`.leaf`-mention + flags
stale rows.
- **Verified:** V0; V1 — check builds green (78 options); negative test:
same script vs the pre-fix README reports exactly the 9 gaps.
- **Pending:** slices (b) doc drift pass, (c) install story, (d)
recovery runbook.
- **Next suggestion:** item 6 slice (b) — or NEXT#8 (viewers+mime) for
variety; both fine.
## 2026-07-04 — Back audit (iteration #12, item 24)
- **Task:** BACKLOG NOW#24 — every list menu ends in ↩ Back.
- **Did:** audited every `rofi -dmenu` call site in the generated