Documentation presentation (navigation)

The documentation is quite extensive, but I sometimes have troubles navigating it (on-line) and searching through it.
My suggestion is to make a readthedocs - style navigation menu (always visible) so it is clear in which section you are, and also makes navigation more easy

3 Likes

Perhaps even provide a “many-html” version rather the “single-html”.

That was attempted in Vacation PR: multi-paged, styled, searchable docs with wrapper tooling and epubs for NixOS and Nixpkgs by grahamc · Pull Request #68020 · NixOS/nixpkgs · GitHub but it got stuck on some performance issues.

You might be interested in Welcome to the NixOS documentation! — NixOS Manual documentation :wink:
Details in this comment.

3 Likes

I notice some of you have your own PoC to make this work, I appreciate it
Unfortunately it is not official yet? Despite the Nix manual being in a nice format:
https://nixos.org/manual/nix/stable/
but officially rendered nixpkgs and nixos are still one huge html page