From eef8e37fbbcffead46f459bb5740ab89d142a089 Mon Sep 17 00:00:00 2001 From: alexion Date: Fri, 28 Aug 2026 10:37:59 -0400 Subject: [PATCH] docs(nix): use NixOS module terminology --- docs/dictionary.md | 8 ++++---- docs/nix.md | 7 +++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/dictionary.md b/docs/dictionary.md index a698ff8..f241e5a 100644 --- a/docs/dictionary.md +++ b/docs/dictionary.md @@ -45,15 +45,15 @@ 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. Use `Nix module` for the language-level module-system concept. | +| module | dotfiles | In this repository, a self-contained configuration under `modules/`, usually scoped to 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. | | flake | Nix | A Nix project with pinned inputs and declared outputs. Use for the repository-level build unit defined by `flake.nix`. | -| assembly file | Nix | A Nix file under `flake/` that constructs flake outputs or module-system inputs. | +| assembly file | Nix | A Nix file under `flake/` that constructs flake outputs or arguments passed to NixOS modules. | | assembly function | Nix | A project function exposed under `dotfiles` because it creates modules, systems, or assembly values. | -| library file | Nix | A Nix file that defines reusable project functions instead of a Nix module or flake output. | +| library file | Nix | A Nix file that defines reusable project functions instead of a NixOS module or flake output. | | library function | Nix | A pure project function exposed under `dotfiles.lib`. | -| Nix module | Nix | A Nix language unit that declares or sets options through the Nix module system. | +| NixOS module | Nix | A Nix file evaluated by `nixosSystem` for a NixOS configuration. | | overlay | Nix | A function that modifies a Nix package set by adding or replacing packages. | | workspace | Window management | A named or numbered group of windows in a graphical session. Some desktop environments call this a virtual desktop. | diff --git a/docs/nix.md b/docs/nix.md index 67fe740..d63d991 100644 --- a/docs/nix.md +++ b/docs/nix.md @@ -64,8 +64,7 @@ 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 Nix module is any Nix language unit that declares or sets module-system options. -Files under `hosts/`, `guests/`, and `modules/` return Nix modules. +Files under `hosts/`, `guests/`, and `modules/` return NixOS modules. ## Function Arguments @@ -121,9 +120,9 @@ import ./flake { inherit lib inputs self; } ### Keep NixOS module interfaces open Files under `hosts/`, `guests/`, and `modules/` return NixOS modules. -The NixOS module system owns their argument shape. +`nixosSystem` owns their argument shape. Name each argument the module uses. -Keep `...` so the module accepts standard module arguments and special arguments. +Keep `...` so the module accepts standard arguments and special arguments. Avoid: