!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

417 Members
Discussion about documentation improvements around the Nix ecosystem81 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
14 Dec 2023
@raitobezarius:matrix.orgraitobezariusit's good for realtime and is lossy because of missing indexation21:52:32
@jade_:matrix.org@jade_:matrix.orghttps://github.com/NixOS/nixos-homepage/issues/1191 filed a bug, i might do it myself in a week21:52:50
@infinisil:matrix.orginfinisil

jade_:

CONTRIBUTING.md is a guide level explanation of things, and is already too bloody long. It is the wrong place to provide reference level material about our vision for docs.

21:59:35
@infinisil:matrix.orginfinisilI recently made a big effort to make contributing documentation more coherent: https://github.com/NixOS/nixpkgs/pull/24524321:59:57
@jade_:matrix.org@jade_:matrix.org oh and re why it feels out of place on nix.dev, I am in favour of a just contributors site for which nobody feels shame adding sections or putting potentially less polished content on there, but maybe this is a misread of the values involved 21:59:59
@infinisil:matrix.orginfinisilContributing docs should be accessed from the source code as directly as possible, because this kind of thing keeps changing22:00:49
@infinisil:matrix.orginfinisilCompared to the user documentation, which needs to document stable interfaces22:01:11
@jade_:matrix.org@jade_:matrix.orgI 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:matrix.orginfinisilTotally in favor of splitting it up more btw22:02:10
@jade_:matrix.org@jade_:matrix.orgmaybe 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

Show newer messages


Back to Room ListRoom Version: 6