updated option documentation to reflect recent structure changes

2024-11-15 12:34:23 -05:00
parent 2431e4361b
commit d2c461b09e
2 changed files with 276 additions and 273 deletions
--- a/docs/options/system_options.md
+++ b/docs/options/system_options.md
@@ -1,79 +1,92 @@
 # System Options

-## networkModule.enable
-  - Enables my network configuration
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/hardware/network.nix'
+- **sysEnv**
+  - **issue**
+    - **enable**
+      - Enables my custom `/etc/issue` TTY splash screen.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/environment/issue.nix`

-## nixSettings.enable
-  - Enables my NixOS settings
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/environment/nix.nix'
+  - **sddmConfig**
+    - **enable**
+      - Enables my Catppuccin-SDDM configuration.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/environment/sddm.nix`

-## bootLoader.enable
-  - Enables my bootloader settings
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/hardware/bootloader.nix'
+  - **stylixConfig**
+    - **enable**
+      - Enables Stylix for system theming.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/environment/stylix.nix`

-## issue.enable
-  - Enables my custom /etc/issue tty splash screen
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/environment/issue.nix'
+  - **nixSettings**
+    - **enable**
+      - Enables my NixOS settings.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/environment/nix.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'
+- **hardwareCfg**
+  - **networkModule**
+    - **enable**
+      - Enables my network configuration.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/hardware/network.nix`

-## gamingPkgs.enable
-  - Enables gaming-related packages
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/software/gaming/gaming_pkgs.nix'
+  - **bootLoader**
+    - **enable**
+      - Enables my bootloader settings.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/hardware/bootloader.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'
+- **softwareCfg**
+  - **gamingPkgs**
+    - **enable**
+      - Enables gaming-related packages.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/gaming/gaming_pkgs.nix`

-## sysProgs.enable
-  - Enables
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/software/programs.nix'
+  - **steamConfig**
+    - **enable**
+      - Enables my Steam configuration.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/gaming/steam.nix`

-## sysServices.enable
-  - Description
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/software/services.nix'
+  - **sysPkgs**
+    - **enable**
+      - Installs my default system packages.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/packages.nix`

-## virtConfig.enable
-  - Description
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/software/virtualization.nix'
+  - **sysProgs**
+    - **enable**
+      - Enables my system programs.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/programs.nix`

-## powerProfiles.enable
-  - Description
-  - Type: Boolean
-  - Default: false
-  - Defined in 'modules/sys/hardware/powerprofiles.nix'
+  - **sysServices**
+    - **enable**
+      - Enables system services.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/services.nix`
+
+  - **virtConfig**
+    - **enable**
+      - Enables virtualization-related configuration.
+      - *Type*: Boolean
+      - *Default*: `false`
+      - *Defined in*: `modules/sys/software/virtualization.nix`