docs: repo layout, module catalogue, host READMEs, stale-path fixes #56

Merged
lyrathorpe merged 6 commits from docs/audit-improvements into main 2026-07-06 15:37:29 +01:00
Owner

Documentation improvements from a repo audit (docs-only; no code changed).

  • README: adds a Repository layout section, a full module catalogue (each modules/* — what it does, how it's imported, when to use it), and an Adding a new host guide; fixes the shared-layers paragraph; links the new host READMEs.
  • New host READMEs: hosts/EDaaS (WSL/Docker-Desktop plumbing, renovate timer) and hosts/Darwin (package sourcing, Touch-ID sudo, macOS defaults) — both were missing.
  • Stale-path fixes: hosts/T400, hosts/MacPro31, hosts/RPi5 READMEs referenced the pre-refactor system/…/swaywm.nix layout; corrected to modules/… and hosts/….

Audited at c06a57f; the SSSD/agenix docs are intentionally not here — they arrive with #55 (different README sections, so no overlap). Quality findings filed separately as an issue.

Documentation improvements from a repo audit (docs-only; no code changed). - **README**: adds a Repository layout section, a full **module catalogue** (each `modules/*` — what it does, how it's imported, when to use it), and an **Adding a new host** guide; fixes the shared-layers paragraph; links the new host READMEs. - **New host READMEs**: `hosts/EDaaS` (WSL/Docker-Desktop plumbing, renovate timer) and `hosts/Darwin` (package sourcing, Touch-ID sudo, macOS defaults) — both were missing. - **Stale-path fixes**: `hosts/T400`, `hosts/MacPro31`, `hosts/RPi5` READMEs referenced the pre-refactor `system/…`/`swaywm.nix` layout; corrected to `modules/…` and `hosts/…`. Audited at `c06a57f`; the SSSD/agenix docs are intentionally not here — they arrive with #55 (different README sections, so no overlap). Quality findings filed separately as an issue.
lyrathorpe added 6 commits 2026-07-06 15:27:04 +01:00
lyrathorpe added 1 commit 2026-07-06 15:27:05 +01:00
docs(rpi5): fix stale module paths
CI / flake (pull_request) Successful in 19s
819633260e
lyrathorpe merged commit ad9decdf47 into main 2026-07-06 15:37:29 +01:00
lyrathorpe deleted branch docs/audit-improvements 2026-07-06 15:37:30 +01:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lyrathorpe/nixfiles#56