extra documentation and cleanup

This commit is contained in:
twoneis 2024-08-05 18:59:37 +02:00
parent 9b4a4baff2
commit debd618690

View file

@ -6,7 +6,7 @@ in {
conf = { conf = {
apps.enable = mkEnableOption "Enable complete configuration for end-user machine."; apps.enable = mkEnableOption "Enable complete configuration for end-user machine.";
niri.enable = mkEnableOption "Enable niri compositor."; niri.enable = mkEnableOption "Enable niri compositor.";
vm.enable = lib.mkEnableOption "Enable VM related configuration."; vm.enable = mkEnableOption "Enable VM related configuration.";
containers.enable = mkEnableOption "Enable container support."; containers.enable = mkEnableOption "Enable container support.";
games.enable = mkEnableOption "Enable games."; games.enable = mkEnableOption "Enable games.";
impermanence.enable = mkEnableOption "Use impermanence module."; impermanence.enable = mkEnableOption "Use impermanence module.";
@ -22,18 +22,21 @@ in {
stateVersion = mkOption { stateVersion = mkOption {
type = nullOr str; type = nullOr str;
description = "Nixos state version. Set to newest on first install and then don't change.";
default = null; default = null;
example = "24.05"; example = "24.05";
}; };
hmStateVersion = mkOption { hmStateVersion = mkOption {
type = nullOr str; type = nullOr str;
description = "Home-Manager state version. Set to newest on first install and then don't change.";
default = null; default = null;
example = "24.11"; example = "24.11";
}; };
keys = mkOption { keys = mkOption {
type = attrsOf str; type = attrsOf str;
description =- "Default key binds.";
default = { default = {
up = "t"; up = "t";
down = "n"; down = "n";
@ -58,6 +61,7 @@ in {
theme = mkOption { theme = mkOption {
type = attrsOf str; type = attrsOf str;
description = "Colors to be used for theming, the names and colors are from the rose-pine theme.";
default = { default = {
base = "#191724"; base = "#191724";
surface = "#1f1d2e"; surface = "#1f1d2e";