Static Site

[lorenzleutgeb]

Fixes #165

Comments:

• Code to generate a (quite large) list/dump of options is in flake.nix, all details regarding the static site is in overview/*.
• Since there's currently no straightforward way to query the module system about which options are defined in a given module, I had to add nixos.modules.<name>.options to the schema for projects/*/default.nix which is a regex that describes the names of the options that the module at nixos.modules.<name>.path defines. I don't particularly like this, but it's the best solution I can think of at the moment. I did briefly consult with the module system maintainers on Matrix.
• Uses Pandoc to generate the HTML.
• Uses the v.Nu HTML checker to ensure that our generated HTML is sane.
• Also pipes through configurations with syntax highlighting (powered by Pandoc or whatever it depends on for syntax highlighting).

[fricklerhandwerk]

@lorenzleutgeb I understand this as a stopgap to get things off the ground, but really don't like this stringly typed pattern. What if we instead had

modules.services.kbin = ./service.nix

and use the actual attrpath down from modules as the key in the website rendering? It would impose some constraints on how to lay out the module code, but that don't feel too bad at first glance.

[lorenzleutgeb]

That proposal works out for NixOS modules, yes. But not for, say, home-manager. We could do that by inverting things...

{
  modules = {
    nixos.services.kbin = ./service.nix;
    homeManager.programs.kbin-client-tool = ./hm.nix;
  };
}

But that's also not nice. Because we already have nixos.{tests,configurations}. So I suggest that we would add homeManager at the NixOS level once we actually have non-NixOS modules:

{
  nixos.modules.services.kbin = ./services.nix;
  homeManager.modules.programs.kbin-client-tool = ./hm.nix;
}

Will create an updated PR.

[lorenzleutgeb]

Wait... We also have to flatten the module names for flake outputs. So these names would get longer, e.g. nixosModules."KBin/services/kbin" but we could use the option path itself only, e.g. nixosModules."services.kbin".

[fricklerhandwerk]

I suggest that we would add homeManager at the NixOS level once we actually have non-NixOS modules

That's what I had in mind, yes.