added basic documentation for module options

docs/options/home_options.md

@@ -0,0 +1,230 @@
+# Home-Manager Options
+
+## homeFiles.enable
+	- Enables my declared files
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/files/neofetch.nix'
+
+## hyprlandConfig.enable
+	- Enables my custom hyprland configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/hyprland.nix'
+
+## autojumpConfig.enable
+	- Enables my autojump options
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/autojump.nix'
+
+## stylixHomeConfig.enable
+	- Enables my stylix home-manager options
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/stylix.nix'
+
+## waybarConfig.enable
+	- Enables my custom waybar configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/waybar.nix'
+
+## gtkConfig.enable
+	- Enables my gtk configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/gtk.nix'
+
+## spicetifyConfig.enable
+	- Enables my spicetify configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/spicetify.nix'
+
+## starshipConfig.enable
+	- Enables my starship configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/starship.nix'
+
+## btopConfig.enable
+	- Enables my btop configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/btop.nix'
+
+## swayncConfig.enable
+	- Enables my swaync configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/swaync.nix'
+
+## userPkgs.enable
+	- Enables my default user packages
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/userpkgs.nix'
+
+## cavaConfig.enable
+	- Enables my cava configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/cava.nix'
+
+## ezaConfig.enable
+	- Enables my eza configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/eza.nix'
+
+## firefoxConfig.enable
+	- Enables my firefox configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/firefox.nix'
+
+## fuzzelConfig.enable
+	- Enables my fuzzel configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/fuzzel.nix'
+
+## fzfConfig.enable
+	- Enables my fzf configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/fzf.nix'
+
+## gitConfig.enable
+	- Enables my git configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/git.nix'
+
+## kittyConfig.enable
+	- Enables my kitty configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/kitty.nix'
+
+## yaziConfig.enable
+	- Enables my yazi configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/yazi.nix'
+
+## zshConfig.enable
+	- Enables my zsh configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/environment/zshell.nix'
+
+## passConfig.enable
+	- Enables my password-store configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/password-store.nix'
+
+## batConfig.enable
+	- Enables my bat configuration
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/programs/bat.nix'
+
+## movScripts.enable
+	- Enables my custom script binaries
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+
+## movScripts.commandScripts
+### enable
+	- Enables my custom command scripts
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### invoke.enable
+	- Enables the invoke command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### runbg.enable
+	- Enables the runbg command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### splash.enable
+	- Enables the splash command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### toolbelt.enable
+	- Enables the toolbelt command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### viconf.enable
+	- Enables the viconf command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+
+## movScripts.hyprlandControls
+### enable
+	- Enables my hyprland control shortcut scripts
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### chpaper.enable
+	- Enables the chpaper command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### scheck.enable
+	- Enables the scheck command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### chscheme.enable
+	- Enables the chscheme command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### keyring.enable
+	- Enables the keyring command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### moveonscreen.enable
+	- Enables the moveonscreen command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### switchmon.enable
+	- Enables the switchmon command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+
+## movScripts.nixShortcuts
+### enable
+	- Enables my NixOS aliases
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### garbage-collect.enable
+	- Enables the garbage-collect command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### nsp.enable
+	- Enables the nsp command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'
+### rebuild.enable
+	- Enables the rebuild command
+	- Type: Boolean
+	- Default: true
+	- Defined in 'modules/home/scripts/default.nix'

docs/options/system_options.md

@@ -0,0 +1,79 @@
+# System Options
+
+## networkModule.enable
+	- Enables my network configuration
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/hardware/network.nix'
+
+## nixSettings.enable
+	- Enables my NixOS settings
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/environment/nix.nix'
+
+## bootLoader.enable
+	- Enables my bootloader settings
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/hardware/bootloader.nix'
+
+## issue.enable
+	- Enables my custom /etc/issue tty splash screen
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/environment/issue.nix'
+
+## sddmConfig.enable
+	- Enables my catppuccin-sddm configuration
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/environment/sddm.nix'
+
+## stylixConfig.enable
+	- Enables stylix for system theming
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/environment/stylix.nix'
+
+## gamingPkgs.enable
+	- Enables gaming-related packages
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/gaming/gaming_pkgs.nix'
+
+## steamConfig.enable
+	- Enables my Steam configuration
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/gaming/steam.nix'
+
+## sysPkgs.enable
+	- Installs my default system packages
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/packages.nix'
+
+## sysProgs.enable
+	- Enables
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/programs.nix'
+
+## sysServices.enable
+	- Description
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/services.nix'
+
+## virtConfig.enable
+	- Description
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/software/virtualization.nix'
+
+## powerProfiles.enable
+	- Description
+	- Type: Boolean
+	- Default: false
+	- Defined in 'modules/sys/hardware/powerprofiles.nix'

modules/home/default.nix

@@ -16,36 +16,36 @@
   ];
 
   # ./files
-  homeFiles.enable = lib.mkDefault true;
+  homeFiles.enable = lib.mkDefault false;
 
   # ./environment
-  hyprlandConfig.enable = lib.mkDefault true;
-  autojumpConfig.enable = lib.mkDefault true;
-  stylixHomeConfig.enable = lib.mkDefault true;
-  waybarConfig.enable = lib.mkDefault true;
-  gtkConfig.enable = lib.mkDefault true;
-  spicetifyConfig.enable = lib.mkDefault true;
-  starshipConfig.enable = lib.mkDefault true;
+  hyprlandConfig.enable = lib.mkDefault false;
+  autojumpConfig.enable = lib.mkDefault false;
+  stylixHomeConfig.enable = lib.mkDefault false;
+  waybarConfig.enable = lib.mkDefault false;
+  gtkConfig.enable = lib.mkDefault false;
+  spicetifyConfig.enable = lib.mkDefault false;
+  starshipConfig.enable = lib.mkDefault false;
 
   # ./programs
-  btopConfig.enable = lib.mkDefault true;
-  swayncConfig.enable = lib.mkDefault true;
-  userPkgs.enable = lib.mkDefault true;
-  cavaConfig.enable = lib.mkDefault true;
-  ezaConfig.enable = lib.mkDefault true;
-  firefoxConfig.enable = lib.mkDefault true;
-  fuzzelConfig.enable = lib.mkDefault true;
-  fzfConfig.enable = lib.mkDefault true;
-  gitConfig.enable = lib.mkDefault true;
-  kittyConfig.enable = lib.mkDefault true;
-  yaziConfig.enable = lib.mkDefault true;
-  zshConfig.enable = lib.mkDefault true;
-  passConfig.enable = lib.mkDefault true;
-  batConfig.enable = lib.mkDefault true;
+  btopConfig.enable = lib.mkDefault false;
+  swayncConfig.enable = lib.mkDefault false;
+  userPkgs.enable = lib.mkDefault false;
+  cavaConfig.enable = lib.mkDefault false;
+  ezaConfig.enable = lib.mkDefault false;
+  firefoxConfig.enable = lib.mkDefault false;
+  fuzzelConfig.enable = lib.mkDefault false;
+  fzfConfig.enable = lib.mkDefault false;
+  gitConfig.enable = lib.mkDefault false;
+  kittyConfig.enable = lib.mkDefault false;
+  yaziConfig.enable = lib.mkDefault false;
+  zshConfig.enable = lib.mkDefault false;
+  passConfig.enable = lib.mkDefault false;
+  batConfig.enable = lib.mkDefault false;
 
   # ./scripts
-  movScripts.enable = lib.mkDefault true;
-  movScripts.commandScripts.enable = lib.mkDefault true;
-  movScripts.hyprlandControls.enable = lib.mkDefault true;
-  movScripts.nixShortcuts.enable = lib.mkDefault true;
+  movScripts.enable = lib.mkDefault false;
+  movScripts.commandScripts.enable = lib.mkDefault false;
+  movScripts.hyprlandControls.enable = lib.mkDefault false;
+  movScripts.nixShortcuts.enable = lib.mkDefault false;
 }

modules/sys/software/packages.nix

@@ -44,6 +44,9 @@
       nix-prefetch-scripts
       nixos-option
       nix-search-cli
+      nix-template
+      mkdocs
+      python3Packages.mkdocs-material
       nvd
       openssl
       p7zip