From cd30aba3e10250af6bcc183b8f42f2d20fd50208 Mon Sep 17 00:00:00 2001
From: Gabriel Arazas <foodogsquared@foodogsquared.one>
Date: Sun, 26 May 2024 16:38:22 +0800
Subject: [PATCH] config: update comments

---
 configs/flake-parts/default.nix                            | 2 +-
 modules/flake-parts/setups/default.nix                     | 5 +++++
 modules/flake-parts/setups/nixvim.nix                      | 3 +++
 modules/nixos/_private/workflows/a-happy-gnome/default.nix | 5 ++++-
 modules/nixos/_private/workflows/default.nix               | 5 +++++
 5 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/configs/flake-parts/default.nix b/configs/flake-parts/default.nix
index ebe6f8a8..b4554a41 100644
--- a/configs/flake-parts/default.nix
+++ b/configs/flake-parts/default.nix
@@ -4,7 +4,7 @@
     ./packages.nix
     ./templates.nix
 
-    # The environment configurations.
+    # Environment configurations.
     ./disko.nix
     ./home-manager.nix
     ./nixos.nix
diff --git a/modules/flake-parts/setups/default.nix b/modules/flake-parts/setups/default.nix
index 221dd419..bb2e1d35 100644
--- a/modules/flake-parts/setups/default.nix
+++ b/modules/flake-parts/setups/default.nix
@@ -1,3 +1,8 @@
+# The declarative environment management modules. Basically the backbone of my
+# flake. Most of the modules here should have some things integrated within
+# each other such as the ability to easily declare home-manager users (or a
+# NixVim instance) into a NixOS system from already existing declared
+# home-manager users (or NixVim instances) in the flake config.
 {
   imports = [
     ./disko.nix
diff --git a/modules/flake-parts/setups/nixvim.nix b/modules/flake-parts/setups/nixvim.nix
index 5b439bbb..c9a2e5e3 100644
--- a/modules/flake-parts/setups/nixvim.nix
+++ b/modules/flake-parts/setups/nixvim.nix
@@ -130,6 +130,9 @@ in
                         config.allowUnfree = true;
                       };
 
+                      # Unfortunately we cannot have NixVim with Neovim-reliant
+                      # packages such as Neovide or something similar. It has
+                      # to be Neovim.
                       neovimPackages = metadata.neovimPackages pkgs;
 
                       mkNixvimConfig' = neovimPkg:
diff --git a/modules/nixos/_private/workflows/a-happy-gnome/default.nix b/modules/nixos/_private/workflows/a-happy-gnome/default.nix
index 06794452..654d0380 100644
--- a/modules/nixos/_private/workflows/a-happy-gnome/default.nix
+++ b/modules/nixos/_private/workflows/a-happy-gnome/default.nix
@@ -85,7 +85,7 @@ in
   };
 
   config = lib.mkIf (lib.elem workflowName config.workflows.enable) {
-    # Enable GNOME and GDM.
+    # Enable GNOME.
     services.xserver = {
       enable = true;
       desktopManager.gnome.enable = true;
@@ -113,6 +113,9 @@ in
     # Bring all of the dconf keyfiles in there.
     programs.dconf = {
       enable = true;
+
+      # In this case, we're using the default user dconf profile which is the
+      # fallback for every dconf-using components. Pretty handy.
       profiles.user.databases = lib.singleton {
         # Get them keyfiles.
         keyfiles = [ ./config/dconf ];
diff --git a/modules/nixos/_private/workflows/default.nix b/modules/nixos/_private/workflows/default.nix
index e9d87236..a68075e6 100644
--- a/modules/nixos/_private/workflows/default.nix
+++ b/modules/nixos/_private/workflows/default.nix
@@ -10,6 +10,11 @@
     description = ''
       A list of workflows to be enabled.
     '';
+    example = [
+      "a-happy-gnome"
+      "knome"
+      "horizontal-hunger"
+    ];
   };
 
   imports = [