docs(install): stitch the README → template first-run handoff — item 6 complete
All checks were successful
Check / eval (push) Successful in 2m55s

Slice (c), the last of the docs review: the install/first-run story
read end to end against the tree. Facts held (mkFlake args match the
table, disko's @snapshots + hibernation swapfile, .#default/.#me
naming); the one seam — README §3 never pointed the manual path at the
template README's first-run steps — got a connective paragraph. Item 6
deleted from BACKLOG; ROADMAP § Full docs review flipped to ✓.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Bernardo Magri
2026-07-04 19:45:34 +01:00
parent 472d7502b4
commit e05e3647e6
4 changed files with 34 additions and 28 deletions

View File

@@ -353,18 +353,15 @@ how to override it. Items marked ✓ are shipped.
hand-formatting, so `nixfmt-rfc-style --check` flags ~33 files. Adopting a
formatter would be a one-time repo-wide reformat that flattens that
alignment — a maintainer call, not a silent cleanup, so left untouched.
- **Full docs review & restructure:** a dedicated pass over all the prose,
not just the code-adjacent cleanup the repo-sanitize item covers. The
README has grown to ~540 lines with a ~200-line roadmap inline — the
biggest single move is likely **splitting the roadmap out** (e.g.
`ROADMAP.md` / `docs/`) so the README stays a focused "what it is / how
to install / how to override" entry point. Also: reconcile every option
table against the live `nomarchy.*` surface (snapper and others are
missing); a pass over `docs/OVERRIDES.md` + `docs/TESTING.md` and the
`templates/downstream/README.md` for drift; check the install/first-run
story reads cleanly end to end; and decide whether anything wants a real
docs site vs. staying Markdown-in-repo. Pairs with the first-boot welcome
and control-center items (shared "how do I…" surface).
- **Full docs review & restructure** (completed 2026-07-04 in four
slices): the roadmap/backlog split (this file + agent/BACKLOG.md);
option tables reconciled with the live surface and guarded permanently
by `checks.option-docs`; drift pass over OVERRIDES/TESTING/template
README (claims held; two gaps fixed); the install/first-run story now
hands off README §3 → template README explicitly; and a new
**docs/RECOVERY.md** runbook (generations → journals → older boot
generation → snapper → nixos-enter). Still open, deliberately: the
docs-site-vs-Markdown call (BACKLOG § Decisions).
- **Laptop power / battery management:** a real power story behind a
`nomarchy.system.power.*` surface (`modules/nixos/power.nix`), replacing the
old "only `services.upower` for Waybar reporting" baseline: