Add description field to function-schema

checks/installation/flake-module.nix

@@ -12,11 +12,11 @@
       { lib, modulesPath, ... }:
       {
         imports = [
-          self.clanModules.diskLayouts
+          self.clanModules.disk-layouts
           (modulesPath + "/testing/test-instrumentation.nix") # we need these 2 modules always to be able to run the tests
           (modulesPath + "/profiles/qemu-guest.nix")
         ];
-        clan.diskLayouts.singleDiskExt4.device = "/dev/vdb";
+        clan.disk-layouts.singleDiskExt4.device = "/dev/vdb";
 
         environment.etc."install-successful".text = "ok";
 

clanModules/borgbackup/README.md

@@ -0,0 +1,2 @@
+BorgBackup is an efficient backup program that uses data deduplication to store only changes, making it ideal for daily backups. It offers optional compression and authenticated encryption, ensuring secure backups even to untrusted targets.
+---

clanModules/disk-layouts/README.md

@@ -0,0 +1 @@
+---

clanModules/disk-layouts/default.nix

@@ -1,6 +1,6 @@
 { config, lib, ... }:
 {
-  options.clan.diskLayouts.singleDiskExt4 = {
+  options.clan.disk-layouts.singleDiskExt4 = {
     device = lib.mkOption {
       type = lib.types.str;
       example = "/dev/disk/by-id/ata-Samsung_SSD_850_EVO_250GB_S21PNXAGB12345";
@@ -13,7 +13,7 @@
       disk = {
         main = {
           type = "disk";
-          device = config.clan.diskLayouts.singleDiskExt4.device;
+          device = config.clan.disk-layouts.singleDiskExt4.device;
           content = {
             type = "gpt";
             partitions = {

clanModules/ergochat/README.md

@@ -0,0 +1 @@
+---

clanModules/flake-module.nix

@@ -1,28 +1,34 @@
 { inputs, ... }:
 {
   flake.clanModules = {
-    diskLayouts = {
+    disk-layouts = {
       imports = [
-        ./diskLayouts.nix
+        ./disk-layouts
         inputs.disko.nixosModules.default
       ];
     };
-    borgbackup = ./borgbackup.nix;
+    borgbackup = ./borgbackup;
-    ergochat = ./ergochat.nix;
+    ergochat = ./ergochat;
     deltachat = ./deltachat;
-    graphical = ./graphical.nix;
+    graphical = ./graphical;
-    localbackup = ./localbackup.nix;
+    localbackup = ./localbackup;
-    localsend = ./localsend.nix;
+    localsend = ./localsend;
-    matrix-synapse = ./matrix-synapse.nix;
+    matrix-synapse = ./matrix-synapse;
-    moonlight = ./moonlight.nix;
+    moonlight = ./moonlight;
-    sshd = ./sshd.nix;
+    sshd = ./sshd;
-    sunshine = ./sunshine.nix;
+    sunshine = ./sunshine;
     syncthing = ./syncthing;
     root-password = ./root-password;
-    thelounge = ./thelounge.nix;
+    thelounge = ./thelounge;
-    vm-user = ./vm-user.nix;
+    vm-user = ./vm-user;
-    xfce = ./xfce.nix;
+    xfce = ./xfce;
-    xfce-vm = ./xfce-vm.nix;
+    xfce-vm = {
-    zt-tcp-relay = ./zt-tcp-relay.nix;
+      imports = [
+        ./vm-user
+        ./graphical
+        ./xfce-vm
+      ];
+    };
+    zt-tcp-relay = ./zt-tcp-relay;
   };
 }

clanModules/graphical/README.md

@@ -0,0 +1 @@
+---

clanModules/localbackup/README.md

@@ -0,0 +1 @@
+---

clanModules/localsend/README.md

@@ -0,0 +1 @@
+---

clanModules/matrix-synapse/README.md

@@ -0,0 +1 @@
+---

clanModules/moonlight/README.md

@@ -0,0 +1 @@
+---

clanModules/sshd/README.md

@@ -0,0 +1 @@
+---

clanModules/sunshine/README.md

@@ -0,0 +1 @@
+---

clanModules/thelounge/README.md

@@ -0,0 +1 @@
+---

clanModules/vm-user/README.md

@@ -0,0 +1 @@
+---

clanModules/xfce-vm/README.md

@@ -0,0 +1 @@
+---

clanModules/xfce-vm/default.nix

@@ -1,9 +1,4 @@
 {
-  imports = [
-    ./vm-user.nix
-    ./graphical.nix
-  ];
-
   services.xserver = {
     enable = true;
     displayManager.autoLogin.enable = true;

clanModules/xfce/README.md

@@ -0,0 +1 @@
+---

clanModules/zt-tcp-relay/README.md

@@ -0,0 +1 @@
+---

docs/mkdocs.yml

@@ -55,7 +55,7 @@ nav:
       - clanModules:
           - reference/clanModules/borgbackup.md
           - reference/clanModules/deltachat.md
-          - reference/clanModules/diskLayouts.md
+          - reference/clanModules/disk-layouts.md
           - reference/clanModules/ergochat.md
           - reference/clanModules/graphical.md
           - reference/clanModules/localbackup.md

pkgs/schemas/flake-module.nix

@@ -46,7 +46,7 @@
       checks = {
         module-schema = pkgs.runCommand "schema-checks" { } ''
           ${pkgs.check-jsonschema}/bin/check-jsonschema \
-            --check-metaschema ${packages.module-schema}
+            --check-metaschema --fill-defaults ${packages.module-schema}
           touch $out
         '';
       };

templates/new-clan/modules/shared.nix

@@ -2,7 +2,7 @@
 {
   imports = [
     clan-core.clanModules.sshd
-    clan-core.clanModules.diskLayouts
+    clan-core.clanModules.disk-layouts
     clan-core.clanModules.root-password
   ];
 }