From 79b20cf3d9aba211491e72d2ec2c05dc6a6e5092 Mon Sep 17 00:00:00 2001
From: Johannes Kirschbauer <hsjobeki@gmail.com>
Date: Wed, 25 Sep 2024 13:33:46 +0200
Subject: [PATCH] Docs/buildClan: add documentation descriptions

---
 lib/build-clan/eval-docs.nix    | 16 +++++++++++++++
 lib/build-clan/flake-module.nix | 15 ++++++++++----
 lib/build-clan/interface.nix    | 36 ++++++++++++++++++++++++++++++++-
 3 files changed, 62 insertions(+), 5 deletions(-)
 create mode 100644 lib/build-clan/eval-docs.nix

diff --git a/lib/build-clan/eval-docs.nix b/lib/build-clan/eval-docs.nix
new file mode 100644
index 000000000..bac768666
--- /dev/null
+++ b/lib/build-clan/eval-docs.nix
@@ -0,0 +1,16 @@
+{ pkgs, lib }:
+let
+  eval = lib.evalModules {
+    modules = [
+      ./interface.nix
+    ];
+  };
+  evalDocs = pkgs.nixosOptionsDoc {
+    options = eval.options;
+    warningsAreErrors = false;
+  };
+in
+{
+  inherit (evalDocs) optionsJSON optionsNix;
+  inherit eval;
+}
diff --git a/lib/build-clan/flake-module.nix b/lib/build-clan/flake-module.nix
index 13310663a..66a5a665f 100644
--- a/lib/build-clan/flake-module.nix
+++ b/lib/build-clan/flake-module.nix
@@ -1,11 +1,14 @@
-{ self, inputs, ... }:
+{
+  self,
+  inputs,
+  ...
+}:
 let
   inputOverrides = builtins.concatStringsSep " " (
     builtins.map (input: " --override-input ${input} ${inputs.${input}}") (builtins.attrNames inputs)
   );
 in
 {
-
   perSystem =
     {
       pkgs,
@@ -13,10 +16,14 @@ in
       system,
       ...
     }:
-    # let
+    let
+      jsonDocs = import ./eval-docs.nix {
+        inherit pkgs lib;
+      };
 
-    # in
+    in
     {
+      legacyPackages.clan-internals-docs = jsonDocs.optionsJSON;
 
       # Run: nix-unit --extra-experimental-features flakes --flake .#legacyPackages.x86_64-linux.evalTests
       legacyPackages.evalTests-build-clan = import ./tests.nix {
diff --git a/lib/build-clan/interface.nix b/lib/build-clan/interface.nix
index b33275165..1a85c998c 100644
--- a/lib/build-clan/interface.nix
+++ b/lib/build-clan/interface.nix
@@ -33,15 +33,36 @@ in
 
     # Optional
     machines = lib.mkOption {
-      type = types.attrsOf types.deferredModule;
+      type = types.deferredModule;
       default = { };
+      description = ''
+        A mapping of machine names to their nixos configuration.
+
+        ???+ example
+
+            ```nix
+            machines = {
+              my-machine = {
+                # Your nixos configuration
+              };
+            };
+            ```
+      '';
     };
     inventory = lib.mkOption {
       type = types.submodule { imports = [ ../inventory/build-inventory/interface.nix ]; };
+      description = ''
+        The `Inventory` submodule.
+
+        For details see the [Inventory](./inventory.md) documentation.
+      '';
     };
 
     # Meta
     meta = lib.mkOption {
+      description = ''
+        Global information about the clan.
+      '';
       type = types.nullOr (
         types.submodule {
           options = {
@@ -58,15 +79,28 @@ in
     pkgsForSystem = lib.mkOption {
       type = types.functionTo (types.nullOr types.attrs);
       default = _: null;
+      defaultText = "Lambda :: String -> { ... } | null";
+      description = ''
+        A function that maps from architecture to pkg. `( string -> pkgs )`
+
+        If specified this nixpkgs will be only imported once for each system.
+        This improves performance, but all nipxkgs.* options will be ignored.
+      '';
     };
 
     # Outputs
     nixosConfigurations = lib.mkOption {
+      # Hide from documentation.
+      # Exposed at the top-level of the flake, clan.nixosConfigurations should not used by the user.
+      # Instead, the user should use the `.#nixosConfigurations` attribute of the flake output.
+      visible = false;
       type = types.lazyAttrsOf types.raw;
       default = { };
     };
     # flake.clanInternals
     clanInternals = lib.mkOption {
+      # Hide from documentation. Exposes internals to the cli.
+      visible = false;
       # type = types.raw;
       # ClanInternals
       type = types.submodule {