docs: add roadmap item for a full docs review & restructure

A dedicated prose pass distinct from the repo-sanitize item: split the
~200-line roadmap out of the README, reconcile the option tables with the
live nomarchy.* surface, and review docs/ + the downstream template for
drift.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
2026-06-14 17:46:30 +01:00
parent c47eb5f688
commit 6a22eba0c4

View File

@@ -424,6 +424,18 @@ close · `SUPER+1..9` workspaces · `Print` region screenshot.
comments/docs for drift against the code; and re-check that every file
still earns its place under the `modules`/`hosts`/`themes`/`pkgs`/`tools`
rule of thumb.
- **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).
- **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: