alexion/dotfiles
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(nix): tighten writing style

Browse Source
This commit is contained in:
alexion
2026-08-28 10:41:10 -04:00
parent 12f3abc11e
commit ebd61ee60d
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/dictionary.md
View File

@@ -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. | | 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/`. | | 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. | | 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. | | 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`. | | 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. | | forge | Git | A web service that hosts Git repositories, pull requests, issues, and code review comments. Use when the exact provider does not matter. |

6
docs/nix.md
View File

@@ -59,11 +59,11 @@ Put modules under `modules/`.
Put host configurations under `hosts/<name>/`. Put host configurations under `hosts/<name>/`.
Put host-side guest wiring under `guests/`. Put host-side guest wiring under `guests/`.
Put registry definitions under `registry/`. 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`. Do not add root-level Nix files other than `flake.nix`.
A module is self-contained configuration under `modules/`. 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. Files under `hosts/`, `guests/`, and `modules/` return NixOS modules.
## Function Arguments ## Function Arguments
@@ -176,7 +176,7 @@ lib.genAttrs hostNames mkHost
### Qualify standard library calls in flake assembly ### 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`. Use `lib.mapAttrs` instead of inheriting `mapAttrs` from `lib`.
This keeps the source of each function visible. This keeps the source of each function visible.