lix/doc/manual/generate-xp-features.nix

with builtins;
with import <nix/utils.nix>;

let
  showExperimentalFeature = name: doc:
    squash ''
      ## [`${name}`]{#xp-feature-${name}}

      ${doc}
    '';
in

xps: (concatStringsSep "\n" (attrValues (mapAttrs showExperimentalFeature xps)))
Assemble experimental feature docs outside of Nix itself Instead of constructing a markdown list in C++ (which involved all sorts of nasty string literals), export some JSON and assemble it with the manual build system. Besides following the precedent set with other dumped data, this is a better separate of content and presentation; if we decide for example we want to display this information in a different way, or in a different section of the manual, it will become much easier to do so. 2023-04-05 02:57:11 +00:00			`with builtins;`
use lookup paths in helper expressions consistently this makes the files in question a bit more independent of source location. to find where the value is set and how it's wired up: rg nix=doc/manual 2023-11-30 20:41:47 +00:00			`with import <nix/utils.nix>;`
Assemble experimental feature docs outside of Nix itself Instead of constructing a markdown list in C++ (which involved all sorts of nasty string literals), export some JSON and assemble it with the manual build system. Besides following the precedent set with other dumped data, this is a better separate of content and presentation; if we decide for example we want to display this information in a different way, or in a different section of the manual, it will become much easier to do so. 2023-04-05 02:57:11 +00:00
			`let`
Single page for experimental feature descriptions As requested by @fricklerhandwerk. 2023-04-09 15:01:23 +00:00			`showExperimentalFeature = name: doc:`
			`squash ''`
			## [`${name}`]{#xp-feature-${name}}
Assemble experimental feature docs outside of Nix itself Instead of constructing a markdown list in C++ (which involved all sorts of nasty string literals), export some JSON and assemble it with the manual build system. Besides following the precedent set with other dumped data, this is a better separate of content and presentation; if we decide for example we want to display this information in a different way, or in a different section of the manual, it will become much easier to do so. 2023-04-05 02:57:11 +00:00
Single page for experimental feature descriptions As requested by @fricklerhandwerk. 2023-04-09 15:01:23 +00:00			`${doc}`
			`'';`
Document each store type on its own page This makes for more useful manual table of contents, that displays the information at a glance. The `nix help-stores` command is kept as-is, even though it will show up in the manual with the same information as these pages due to the way it is written as a "`--help`-style" command. Deciding what to do with that command is left for a later PR. This change also lists all store types at the top of the respective overview page. Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems 2023-11-30 22:07:09 +00:00			`in`

			`xps: (concatStringsSep "\n" (attrValues (mapAttrs showExperimentalFeature xps)))`