docs: add generated homeManagerModules readme

apps/gen-docs/script.sh

@@ -20,9 +20,10 @@ substituteModule() {
     ) -t markdown --template "$FLAKE/apps/gen-docs/templates/$1.md" -o "$FLAKE/$1/README.md"
 }
 
-# TODO: add homeManagerModules, lib, modules, nixFastChecks, overlays, scopedPackages
+# TODO: add lib, nixFastChecks, overlays, scopedPackages
 substitute "appsPackages" "apps" "getPackageMeta"
 substitute "nixosConfigurations" "configurations" "getConfigMeta"
 substitute "devShells" "devShells" "getPackageMeta"
 substitute "packages" "packages" "getPackageMeta"
 substituteModule "modules"
+substituteModule "homeManagerModules"

apps/gen-docs/templates/homeManagerModules.md

@@ -0,0 +1,11 @@
+# homeManagerModules
+
+This directory contains every home-manager modules exposed by this flake.
+
+## List of my home-manager modules found in `self.homeManagerModules`
+
+| Name | Description |
+| ---- | ----------- |
+$for(attrs/pairs)$
+| `$it.key$` | $it.value.desc/nowrap$ |
+$endfor$

homeManagerModules/README.md

@@ -0,0 +1,11 @@
+# homeManagerModules
+
+This directory contains every home-manager modules exposed by this flake.
+
+## List of my home-manager modules found in `self.homeManagerModules`
+
+| Name | Description |
+| ---- | ----------- |
+| `firefox` | Uses the home-manager firefox module to declare my custom configuration which includes my list of extensions, my adapted [firefox-gx](https://github.com/Godiesc/firefox-gx) theme and other settings. |
+| `neovim` | Uses the home-manager neovim module to declare my custom configuration and expands it with toggles for certain LSPs. This configuration loads corresponding devShells of the current language from `self.devShells` dynamically to support various LSPs. |
+| `shell` | Extends the bash home-manager options to set some bash options, aliases themes that follow Dracula Theme and settings for CLI programs, such as starship, trash-d, nix-comma, nix-direnv, git, etc. |

homeManagerModules/default.nix

@@ -1,5 +1,37 @@
-self: {
+{
-  firefox = import ./firefox self;
+  self ? {},
-  neovim = import ./neovim self;
+  description ? false,
-  shell = import ./shell self;
+}: let
+  module = mod: desc:
+    if description
+    then desc
+    else mod;
+in {
+  firefox =
+    module
+    (import ./firefox self)
+    ''
+      Uses the home-manager firefox module to declare my custom configuration
+      which includes my list of extensions, my adapted [firefox-gx](https://github.com/Godiesc/firefox-gx)
+      theme and other settings.
+    '';
+
+  neovim =
+    module
+    (import ./neovim self)
+    ''
+      Uses the home-manager neovim module to declare my custom configuration
+      and expands it with toggles for certain LSPs. This configuration loads
+      corresponding devShells of the current language from `self.devShells`
+      dynamically to support various LSPs.
+    '';
+
+  shell =
+    module
+    (import ./shell self)
+    ''
+      Extends the bash home-manager options to set some bash options, aliases
+      themes that follow Dracula Theme and settings for CLI programs, such as
+      starship, trash-d, nix-comma, nix-direnv, git, etc.
+    '';
 }