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

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

let
  showExperimentalFeature = name: doc:
    ''
      - [`${name}`](@docroot@/development/experimental-features.md#xp-feature-${name})
    '';
in xps: indent "  " (concatStrings (attrValues (mapAttrs showExperimentalFeature xps)))
Describe active experimental features in the contributing guide They are put in the manual separate pages under the new overarching description of experimental features. The settings page just lists the valid experimental feature names (so people know what a valid setting entry looks like), with links to those pages. It doesn't attempt to describe each experimental feature as that is too much information for the configuration settings section. 2023-04-06 16:24: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>;`
Describe active experimental features in the contributing guide They are put in the manual separate pages under the new overarching description of experimental features. The settings page just lists the valid experimental feature names (so people know what a valid setting entry looks like), with links to those pages. It doesn't attempt to describe each experimental feature as that is too much information for the configuration settings section. 2023-04-06 16:24:11 +00:00
			`let`
			`showExperimentalFeature = name: doc:`
			`''`
manual: Contributing -> Development, Hacking -> Building (#9014) * manual: Contributing -> Development, Hacking -> Building what's currently called "hacking" are really instructions for setting up a development environment and compiling from source. we have a contribution guide in the repo (which rightly focuses on GitHub workflows), and the material in the manual is more about working on the code itself. since we'd otherwise have three headings that amount to "Building Nix", this change also moves the "classic Nix" instructions to the top. we may want to reorganise this in the future, and bring contributor-oriented information closer to the code, but for now let's stick to more accurate names to ease navigation. 2024-07-25 02:53:06 +00:00			- [`${name}`](@docroot@/development/experimental-features.md#xp-feature-${name})
Describe active experimental features in the contributing guide They are put in the manual separate pages under the new overarching description of experimental features. The settings page just lists the valid experimental feature names (so people know what a valid setting entry looks like), with links to those pages. It doesn't attempt to describe each experimental feature as that is too much information for the configuration settings section. 2023-04-06 16:24:11 +00:00			`'';`
			`in xps: indent " " (concatStrings (attrValues (mapAttrs showExperimentalFeature xps)))`