Docs: add top-level index, refactor according to diataxis

2024-09-22 18:38:14 +02:00
parent 350ed0b1fe
commit 55526b1fdb
11 changed files with 207 additions and 117 deletions
--- a/lib/build-clan/interface.nix
+++ b/lib/build-clan/interface.nix
@@ -8,7 +8,21 @@ in
    directory = lib.mkOption {
      type = types.path;
      default = self;
-      description = "The directory containing the clan subdirectory";
+      defaultText = "Root directory of the flake";
+      description = ''
+        The directory containing the clan.
+
+        A typical directory structure could look like this:
+
+        ```
+        .
+        ├── flake.nix
+        ├── assets
+        ├── machines
+        ├── modules
+        └── sops
+        ```
+      '';
    };

    specialArgs = lib.mkOption {