| 14 Dec 2023 |
 infinisil | Compared to the user documentation, which needs to document stable interfaces | 22:01:11 |
 @jade_:matrix.org | I think my perception of it being very long is also related to GitHub being somewhat troubled with respect to pleasantness of reading long markdown files (even though it even has a table of contents and such!) | 22:01:37 |
| infinisil | Totally in favor of splitting it up more btw | 22:02:10 |
| @jade_:matrix.org | maybe we could generate a site out of the nixpkgs source tree to make that nicer? I agree it's nice to have it in grep scope or nearby the code. looks like rustc people put it separately: https://github.com/rust-lang/rustc-dev-guide
I'm kind of either way on this: having a site generated out of the nixpkgs source could potentially make it non-obvious that the thing is also available in nicer form on the web, and it might discourage contributions due to nixpkgs being huge and the various infelicities of github workflows on large repos. But this is not a strong opinion. | 22:05:35 |
| infinisil | jade_: Maybe we just need more page splitting, more overviews and more cross-linking in the markdown files | 22:06:51 |
| @jade_:matrix.org | yeah, I think mdbook would be nice for search among other things | 22:07:04 |
| @jade_:matrix.org | like, having a nice sidebar also | 22:07:14 |
| @jade_:matrix.org | because it's harder to do page splitting if you don't have nice search and navigation | 22:07:32 |
| 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 |
