foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-30 22:57:55 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: document conventions for setting module arguments

Browse Source
This commit is contained in:
Gabriel Arazas 2025-01-24 18:42:23 +08:00
parent 1c8bf5aef1
commit 0fbaebb322
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
configs/README.adoc
View File

@ -18,3 +18,12 @@ Here is the following list of them used in the repo history:
These "codenames" are also used for their environment-specific module structuring (e.g., `hosts.ni.services.backup.enable` for NixOS, `nixvimConfigs.fiesta.setups.tree-sitter` for NixVim, `users.foo-dogsquared.setups.desktop.enable` for home-manager) with the exception of flake-parts where it is basically a free-for-all.
Lastly, these modules are referred collectively in the commits as `modules`.
[#conventions]
== Conventions
There's a few things you need to remember for these configurations.
- Module arguments that are only suitable to be included in the first build step of the configuration are all under the `firstSetupArgs` namespace.
- Module arguments that are only found inside of the configuration itself should be under the `configurationArgs` namespace.