Yeah, I enjoy hitting F3 twelve times to find the beginning of mkDerivation documentation - silly me, I must’ve known to search for “stdenv” documentation. Or having to find the source-code of makeWrapper because the documentation for it is mostly in the make-wrapper.sh. Or trying to find a lib function in the unsorted list of library functions.
But why is reference documentation in the “manual” anyway and loaded as a single html? The configuration options are also one humongous html, but separated from the manual. So it is possible to separate the manual, but it hasn’t been done for some reason.
Python uses sphinx or mkdocs, rust uses cargo doc, and C/C++ (+ other languages) use doxygen, and they generate multi page, static, documentation with quite reasonable search, but for some reason nix went the single document way requiring Ctrl+F.
It is slowly getting better, but I find external sources to often be much better than the manuals.
Soooooo sorry that all the volunteer labor hasn’t produced something you personally approve of. If only there were some way you could affect change and you weren’t relegated to complaining on the internet!
There has been continual work on the documentation, so not sure what this complaint is about.
Have you looked at it lately?
Yeah, I enjoy hitting F3 twelve times to find the beginning of
mkDerivationdocumentation - silly me, I must’ve known to search for “stdenv” documentation. Or having to find the source-code ofmakeWrapperbecause the documentation for it is mostly in themake-wrapper.sh. Or trying to find a lib function in the unsorted list of library functions.But why is reference documentation in the “manual” anyway and loaded as a single html? The configuration options are also one humongous html, but separated from the manual. So it is possible to separate the manual, but it hasn’t been done for some reason.
Python uses sphinx or mkdocs, rust uses
cargo doc, and C/C++ (+ other languages) use doxygen, and they generate multi page, static, documentation with quite reasonable search, but for some reason nix went the single document way requiring Ctrl+F.It is slowly getting better, but I find external sources to often be much better than the manuals.
Anti Commercial-AI license
Soooooo sorry that all the volunteer labor hasn’t produced something you personally approve of. If only there were some way you could affect change and you weren’t relegated to complaining on the internet!
Lol, I’m a contributor nix related projects (and formerly nixos) with rejected doc related PRs. I tried to help and it wasn’t wanted 🤷
So sorry for having an opinion on the perfect state of nix/nixos documentation. I must not be seeing its perfection.
Anti Commercial-AI license
So you can’t even land a PR on something that is already bad, got it. Good job!