 fricklerhandwerk | In reply to @johannes.kirschbauer:scs.ems.host
I want to share my POC with the documentation team:
https://hsjobeki.github.io/nix-doc-comments/reference/lib/debug/lib-debug-runtests/
Fully automated reference manual for the whole api surface of nix.
In my vision this could replace: https://nix.dev/reference
If you are interested into implementation details; it requires the rfc-145 and migrated-comments (according to the rfc) in nixpkgs. (This is still a POC so expect bugs and beeing incomplete)
This looks great. Still, as @roberth suggested elsewhere recently, we should not encourage using builtins to keep separation of concerns. I suggest rendering what you have to the Nixpkgs manual. It would also avoid getting into hairy consistency problems between Nix and Nixpkgs documentation. The nix.dev reference section should ideally consist only of links to the manuals, but some things are currently hard to do in an ideal way. | 12:51:08 |
