From debd618690269587b08c7ff1ebd2dc22fcc86e8d Mon Sep 17 00:00:00 2001
From: twoneis <sanjay29@sapura.de>
Date: Mon, 5 Aug 2024 18:59:37 +0200
Subject: [PATCH] extra documentation and cleanup

---
 options.nix | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/options.nix b/options.nix
index a4e694b..470caa4 100644
--- a/options.nix
+++ b/options.nix
@@ -6,7 +6,7 @@ in {
     conf = {
       apps.enable = mkEnableOption "Enable complete configuration for end-user machine.";
       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.";
       games.enable = mkEnableOption "Enable games.";
       impermanence.enable = mkEnableOption "Use impermanence module.";
@@ -22,18 +22,21 @@ in {
 
       stateVersion = mkOption {
         type = nullOr str;
+        description = "Nixos state version. Set to newest on first install and then don't change.";
         default = null;
         example = "24.05";
       };
 
       hmStateVersion = mkOption {
         type = nullOr str;
+        description = "Home-Manager state version. Set to newest on first install and then don't change.";
         default = null;
         example = "24.11";
       };
 
       keys = mkOption {
         type = attrsOf str;
+        description =- "Default key binds.";
         default = {
           up = "t";
           down = "n";
@@ -58,6 +61,7 @@ in {
 
     theme = mkOption {
       type = attrsOf str;
+      description = "Colors to be used for theming, the names and colors are from the rose-pine theme.";
       default = {
         base = "#191724";
         surface = "#1f1d2e";