Auto generated docs

[Eldolfin]

Make docs auto generated or better yet, make an auto generated option search like home-manager and nixpkgs, it could be auto deployed to github pages
This could prevent sync issues between the modules and the doc, and would mean less work for the maintainers

[KaylorBen]

Do you recommend any specific tool for this process. I looked around when I started the project, but gave up and wrote the docs myself (I agree, not optimal), but I would like to move to auto generating them at this point.

[Eldolfin]

I just came across this which seems simple enough to add to a project:
https://github.com/NuschtOS/search/
which is used by this repo for example:
https://github.com/NuschtOS/nixos-modules/

which unlike search.nixos is a static site deployed with gh actions+pages. It seems ideal for a project at this scale

for extra customization such as themes, site name or logo, we could make a fork of the repo or simply add it to a folder in this repo.

I'm willing to try to implement it 🙂

edit: also if you want to keep the markdown files, it's probably not too hard to make a script to generate them once we have the options.json file