feat(readme): add headings and descriptions to text.readme

README.md

@@ -1,9 +1,13 @@
-# readme
-## generated-files
+# Pantheon
+This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts.
+
+## Generated Files
 This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation.
 The list of generated files are:
 - [docs/cheatsheet.md](docs/cheatsheet.md)
 - [README.md](README.md)
-## helpers
-### text-helper
-The option `text.<name> supports either a string or a submodule with attributes order and parts. The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.
+## Helpers
+The following are some helpers for the repo as a whole.
+### Generating Text
+The option `text.<name>` supports either a string or a submodule with attributes order and parts.
+The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.

modules/docs/readme.nix

@@ -3,11 +3,21 @@ let
   inherit (lib) singleton;
 in
 {
-  text.readme.order = [
-    "generated-files"
+  text.readme = {
+    heading = "Pantheon";
+    description = ''
+      This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts.
+    '';
+    order = [
+      "Generated Files"
       "helpers"
     ];
-  text.readme.parts.helpers.order = [ "text-helper" ];
+    parts.helpers = {
+      heading = "Helpers";
+      description = "The following are some helpers for the repo as a whole.";
+      order = [ "Generating Text" ];
+    };
+  };
 
   perSystem =
     { pkgs, ... }:

modules/flake-parts/files.nix

@@ -17,7 +17,7 @@ in
   perSystem = psArgs: {
     make-shells.default.packages = [ psArgs.config.files.writer.drv ];
   };
-  text.readme.parts.generated-files = concatStringsSep "\n" (
+  text.readme.parts."Generated Files" = concatStringsSep "\n" (
     [
       "This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation."
 

modules/helpers/text.nix

@@ -70,6 +70,8 @@ in
       name: value: concatStringsSep "\n" (flatten (mkListFromAttrs 1 { inherit name value; }))
     );
   };
-  config.text.readme.parts.helpers.parts.text-helper =
-    "The option `text.<name> supports either a string or a submodule with attributes order and parts. The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.";
+  config.text.readme.parts.helpers.parts."Generating Text" =
+    ''
+      The option `text.<name>` supports either a string or a submodule with attributes order and parts.
+      The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.'';
 }