| 14 Dec 2023 |
infinisil | I guess contributor docs being rendered (as I described it in https://github.com/NixOS/nixpkgs/issues/244056) is the problem. Rather it's that older versions of the documentation is too easily accessible if it were in the user manuals | 22:08:11 |
infinisil | * I guess contributor docs being rendered (as I described it in https://github.com/NixOS/nixpkgs/issues/244056) is the problem. Rather it's that older versions of the contributor documentation is too easily accessible if it were in the user manuals | 22:08:20 |
@jade_:matrix.org | ah yeah, I am definitely not in favour of putting it in the user manual | 22:08:35 |
infinisil | Though using the GitHub markdown rendering is also kind of nice because it's one less thing to worry about and maintain | 22:09:05 |
@jade_:matrix.org | it's useful to delineate this because the style of writing for user manuals and contributor-only docs is rather different | 22:09:13 |
@jade_:matrix.org | i wonder if we could reuse the nix.dev code somehow without causing ourselves too much pain? | 22:09:25 |
infinisil | I think ideally all .md files in Nixpkgs would be collected somehow and rendered together | 22:10:20 |
infinisil | (well, user docs are also written in .md, those shouldn't be included obviously) | 22:11:16 |
infinisil | Oh, but alternatively, what if the render pipelines are separate, but the website puts them into a single document | 22:11:54 |
infinisil | Such that when you go to nixos.org/manual/nixpkgs, it shows you both stable/unstable versions of the released user documentation, but also the latest contributor documentation from master | 22:12:57 |
infinisil | This is generally what I think we should have: A single page that collects materials from different repos | 22:13:22 |
infinisil | And actually we did make a step in that direction with nix.dev: https://nix.dev/reference/nix-manual | 22:13:41 |