From ebd61ee60d223cf612673cf84e8cf648152d3ed6 Mon Sep 17 00:00:00 2001 From: alexion Date: Fri, 28 Aug 2026 10:41:10 -0400 Subject: [PATCH] docs(nix): tighten writing style --- docs/dictionary.md | 2 +- docs/nix.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dictionary.md b/docs/dictionary.md index f241e5a..14e12b9 100644 --- a/docs/dictionary.md +++ b/docs/dictionary.md @@ -45,7 +45,7 @@ Use the simplest accurate word when a term is not listed. | operator | Agent tooling | The human driving the development process. Use when distinguishing the human from the agent acting on their behalf. | | guest | dotfiles | A systemd-nspawn container managed by this flake. Use for configured containers under `guests/`. | | host | dotfiles | A machine with a NixOS configuration built by this flake. | -| module | dotfiles | In this repository, a self-contained configuration under `modules/`, usually scoped to one program, service, or subsystem. | +| module | dotfiles | In this repository, a self-contained configuration under `modules/`. Use for one program, service, or subsystem. | | registry | dotfiles | A typed configuration namespace whose entries can be collected across hosts and reused by other configuration. | | Conventional Commits | Git | A commit-message format defined in `docs/conventional-commits.md`. | | forge | Git | A web service that hosts Git repositories, pull requests, issues, and code review comments. Use when the exact provider does not matter. | diff --git a/docs/nix.md b/docs/nix.md index a5f58c0..8e2fdf0 100644 --- a/docs/nix.md +++ b/docs/nix.md @@ -59,11 +59,11 @@ Put modules under `modules/`. Put host configurations under `hosts//`. Put host-side guest wiring under `guests/`. Put registry definitions under `registry/`. -Keep `flake.nix` focused on inputs and public output wiring. +Keep `flake.nix` focused on inputs and output wiring. Do not add root-level Nix files other than `flake.nix`. A module is self-contained configuration under `modules/`. -It usually scopes to one program, service, or subsystem. +A module configures one program, service, or subsystem. Files under `hosts/`, `guests/`, and `modules/` return NixOS modules. ## Function Arguments @@ -176,7 +176,7 @@ lib.genAttrs hostNames mkHost ### Qualify standard library calls in flake assembly -Use qualified standard library calls inside flake assembly code. +Use qualified standard library calls inside assembly files. Use `lib.mapAttrs` instead of inheriting `mapAttrs` from `lib`. This keeps the source of each function visible.