docs: add doc-comment for template submodule

2025-10-27 17:38:34 +01:00
parent 9503b46b21
commit 3e950bc66f
1 changed files with 25 additions and 0 deletions
--- a/modules/clan/templates.nix
+++ b/modules/clan/templates.nix
@@ -1,3 +1,28 @@
+/**
+  The templates submodule
+
+  'clan.templates'
+
+  Different kinds supported:
+
+  - clan templates: 'clan.templates.clan'
+  - disko templates: 'clan.templates.disko'
+  - machine templates: 'clan.templates.machine'
+
+  A template has the form:
+
+  ```nix
+  {
+    description: string; # short summary what the template contains
+    path: path; # path to the template
+  }
+  ```
+
+  The clan API copies the template from the given 'path'
+  into a target folder. For example,
+
+  `./machines/<machine-name>` for 'machine' templates.
+*/
 {
  lib,
  ...