| 14 Dec 2023 |
@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 |
infinisil | I'd be in favor of making nix.dev be the centralised place for docs (but really all of Nix, see https://github.com/nix-rfc-canonical-domain/rfcs/blob/canonical-domain/rfcs/1000-canonical-domain.md) | 22:14:26 |
@jade_:matrix.org | In reply to @infinisil:matrix.org 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 maybe i am cynical (i read the sources nearly every time i have a docs query :V), but i am greatly most likely to read the contributing docs if they are a "dev only" site with a simplified contribution process that is quicker vs other docs.
i think i agree that nix is a different situation than rust with respect to the ratio of users to contributors, and this does change the calculus with respect to how much to promote the dev specific stuff
| 22:18:01 |
@jade_:matrix.org |  Download image.png | 22:19:05 |
@jade_:matrix.org | it would be really nice to have a version selector on-page with these: | 22:19:06 |
@jade_:matrix.org | overall we need more top bar nav in all our stuff :D | 22:19:20 |
infinisil | Ultimately it boils down to needing more resources | 22:19:58 |
infinisil | And tbh, I should also do some stuff now, talking in a Matrix channel doesn't accomplish much unfortunately (though synchronising with others is useful) | 22:20:27 |