modules/docs: add user-guide

Author: MattSturgeon

modules/docs/default.nix

@@ -14,6 +14,7 @@ in
     ./mdbook
     ./menu
     ./pages.nix
+    ./user-guide
   ];
 
   config.docs = {

modules/docs/user-guide/default.nix

@@ -0,0 +1,33 @@
+{
+  lib,
+  pkgs,
+  ...
+}:
+let
+  user-guide = ../../../docs/user-guide;
+
+  sourceTransformers = {
+    config-examples =
+      template:
+      pkgs.callPackage ./user-configs.nix {
+        inherit template;
+      };
+  };
+in
+{
+  docs.pages = lib.concatMapAttrs (
+    name: type:
+    let
+      title = lib.removeSuffix ".md" name;
+      transformer = sourceTransformers.${title} or lib.id;
+    in
+    lib.optionalAttrs (type == "regular") {
+      "user-guide/${title}" = {
+        menu.section = "user-guide";
+        # TODO: define user-facing titles to show in the menu...
+        menu.location = [ title ];
+        source = transformer "${user-guide}/${name}";
+      };
+    }
+  ) (builtins.readDir user-guide);
+}

modules/docs/user-guide/user-configs.nix

@@ -0,0 +1,14 @@
+{
+  runCommand,
+  callPackage,
+  template,
+}:
+runCommand "user-configs.md"
+  {
+    inherit template;
+    user_configs = callPackage ../../../docs/user-configs { };
+  }
+  ''
+    substitute $template $out \
+      --subst-var-by USER_CONFIGS "$(cat $user_configs)"
+  ''