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

docs(nix): use NixOS module terminology

Browse Source
This commit is contained in:
alexion
2026-08-28 10:37:59 -04:00
parent 1654aef9ae
commit eef8e37fbb
2 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/dictionary.md
View File

@@ -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. | | 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. 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. | | 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. |
| flake | Nix | A Nix project with pinned inputs and declared outputs. Use for the repository-level build unit defined by `flake.nix`. | | 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. | | 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`. | | 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. | | 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. | | workspace | Window management | A named or numbered group of windows in a graphical session. Some desktop environments call this a virtual desktop. |

7
docs/nix.md
View File

@@ -64,8 +64,7 @@ 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. 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 NixOS modules.
Files under `hosts/`, `guests/`, and `modules/` return Nix modules.
## Function Arguments ## Function Arguments
@@ -121,9 +120,9 @@ import ./flake { inherit lib inputs self; }
### Keep NixOS module interfaces open ### Keep NixOS module interfaces open
Files under `hosts/`, `guests/`, and `modules/` return NixOS modules. 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. 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: Avoid: