docs(review): drift pass over OVERRIDES/TESTING/template README (item 6b)
All checks were successful
Check / eval (push) Successful in 3m3s

Slice (b) of the docs review: every factual claim in the three docs
spot-checked against the tree (mkDefault sites, bind priority, CLI
keys, awww naming, preset/wallpaper counts, summer-night's light bar,
live-ISO monitor rule, CI workflow, QEMU GL flags, template steps) —
all held. Two gaps fixed: OVERRIDES §2 predated nomarchy.monitors and
never routed readers to it (added, plus a quick-reference row);
TESTING §1 didn't list the shell-syntax check that §1b says CI runs
(added bash -n).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Bernardo Magri
2026-07-04 19:36:01 +01:00
parent 56f1cc3fa9
commit b0b8a9a09b
4 changed files with 30 additions and 5 deletions

View File

@@ -26,10 +26,11 @@ next, in what order*.
ROADMAP § Full docs review. Done: the roadmap/backlog split (this file); ROADMAP § Full docs review. Done: the roadmap/backlog split (this file);
slice (a) option-surface reconcile — README tables fixed (9 gaps) and slice (a) option-surface reconcile — README tables fixed (9 gaps) and
the diff made permanent as the `option-docs` flake check (eval-walked the diff made permanent as the `option-docs` flake check (eval-walked
surface vs tables, catches stale rows too). Remaining slices: surface vs tables, catches stale rows too); slice (b) drift pass over
- **(b) drift pass** over docs/OVERRIDES.md, docs/TESTING.md, docs/OVERRIDES.md, docs/TESTING.md, templates/downstream/README.md —
templates/downstream/README.md — read each against the current tree, every factual claim spot-checked against the tree, all held; fixed the
fix what lies. two gaps (OVERRIDES now routes to `nomarchy.monitors`; TESTING §1 lists
the shell-syntax check its CI § claimed). Remaining slices:
- **(c) install/first-run story** read end to end (README install §§ + - **(c) install/first-run story** read end to end (README install §§ +
template README as one narrative; fix the seams). template README as one narrative; fix the seams).
- **(d) recovery runbook** — short doc: desktop won't start → boot an - **(d) recovery runbook** — short doc: desktop won't start → boot an

View File

@@ -17,6 +17,23 @@ Template:
--- ---
## 2026-07-04 — docs slice (b): drift pass (iteration #14, item 6b)
- **Task:** BACKLOG NOW#6 slice (b) — OVERRIDES.md / TESTING.md /
templates/downstream/README.md vs the live tree.
- **Did:** spot-checked every factual claim: mkDefault sites (hyprland
behaviour knobs, ghostty paddings, waybar mainBar/style), bind-list
normal priority, `set ui.gapsOut` CLI key, awww(-daemon) naming,
21 presets, tokyo-night's 4 wallpapers, summer-night's light @fg bar,
live `,highres` mkForce, .gitea/workflows/check.yml, QEMU gl flags,
template `.#me` + ~/.nomarchy/NOMARCHY_PATH. All accurate. Fixed the
two real gaps: OVERRIDES §2 predated `nomarchy.monitors` (now routes
there + quick-ref row); TESTING §1 lacked the shell-syntax check §1b
claims CI runs (added `bash -n`).
- **Verified:** V0 (docs-only; flake untouched — check run pre-commit).
- **Pending:** slices (c) install story, (d) recovery runbook.
- **Next suggestion:** item 6 slice (c) or (d) — (d) is self-contained
and ships user value (the runbook).
## 2026-07-04 — docs slice (a): option-surface reconcile (iteration #13, item 6a) ## 2026-07-04 — docs slice (a): option-surface reconcile (iteration #13, item 6a)
- **Task:** BACKLOG NOW#6, first slice — README tables vs live options. - **Task:** BACKLOG NOW#6, first slice — README tables vs live options.
- **Did:** split item 6 into slices (ad) in BACKLOG. Reconciled: 9 - **Did:** split item 6 into slices (ad) in BACKLOG. Reconciled: 9

View File

@@ -39,7 +39,7 @@ in your `home.nix` wins — no `mkForce` needed:
input.follow_mouse = 0; # was 1 input.follow_mouse = 0; # was 1
input.touchpad.natural_scroll = false; input.touchpad.natural_scroll = false;
misc.disable_splash_rendering = false; misc.disable_splash_rendering = false;
monitor = [ "DP-1,2560x1440@144,0x0,1" ]; # replaces the default rule monitor = [ "DP-1,2560x1440@144,0x0,1" ]; # raw rule — replaces the default
animations.enabled = false; animations.enabled = false;
}; };
@@ -50,6 +50,11 @@ in your `home.nix` wins — no `mkForce` needed:
} }
``` ```
For monitor layout, prefer the friendlier **`nomarchy.monitors`** (a list of
per-output submodules — resolution/position/scale/rotation — turned into
Hyprland rules and applied on hotplug; run `nwg-displays` to find the values
interactively). Assigning `settings.monitor` directly, as above, replaces it.
### Adding vs. overriding lists ### Adding vs. overriding lists
`bind`, `bindel`, `bindl`, `bindm` and `exec-once` are lists kept at normal `bind`, `bindel`, `bindl`, `bindm` and `exec-once` are lists kept at normal
@@ -140,6 +145,7 @@ value is theme-owned at normal priority — either change it via the CLI (§1) o
|---|---| |---|---|
| Change gaps / colors / rounding / fonts | `nomarchy-theme-sync set …` or `apply` | | Change gaps / colors / rounding / fonts | `nomarchy-theme-sync set …` or `apply` |
| Change input / misc / monitor / animations / terminal chrome | plain assignment in `home.nix` | | Change input / misc / monitor / animations / terminal chrome | plain assignment in `home.nix` |
| Arrange monitors declaratively | `nomarchy.monitors` (values via `nwg-displays`) |
| Add keybinds / autostarts | add to the `bind` / `exec-once` list (concatenates) | | Add keybinds / autostarts | add to the `bind` / `exec-once` list (concatenates) |
| Replace all keybinds | `bind = lib.mkForce [ … ]` | | Replace all keybinds | `bind = lib.mkForce [ … ]` |
| Hardcode an appearance value against the theme | `lib.mkForce` in `home.nix` | | Hardcode an appearance value against the theme | `lib.mkForce` in `home.nix` |

View File

@@ -14,6 +14,7 @@ than claiming success. "All Nix files parse" is not "the bar renders."
nix flake check --no-build # full module-system evaluation, no builds nix flake check --no-build # full module-system evaluation, no builds
nix-instantiate --parse <file> # syntax-only, works even on macOS nix-instantiate --parse <file> # syntax-only, works even on macOS
python3 -m py_compile pkgs/nomarchy-theme-sync/nomarchy-theme-sync.py python3 -m py_compile pkgs/nomarchy-theme-sync/nomarchy-theme-sync.py
bash -n <script>.sh # shell syntax (tools/, installer bits)
``` ```
`nix flake check` needs a Linux machine (or a Linux builder) since all `nix flake check` needs a Linux machine (or a Linux builder) since all