!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

422 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
14 Dec 2023
@jade_:matrix.org@jade_:matrix.org

infinisil: re this: https://github.com/NixOS/nixpkgs/pull/270696#discussion_r1412898648

this is emblematic of a larger set of problems we have:

  • 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.
  • Relatedly, we need to write these vision documents down.
  • We don't have a https://rustc-dev-guide.rust-lang.org/ for Nix, and we need one desperately. We should make one and start moving things to it.
  • We don't have a repo to file meta issues like I am talking about here, and we need one. Another issue that should be filed in there is "hydra notifications for failed maintained packages", for example.
  • All the places that docs go have different stylesheets and don't link to each other, both as deep links and even shallow links. This gives the impression that they're not part of a coherent ecosystem with one responsible set of people.
  • Our current docs splitting work is partially counterproductive due to this lack of links; but would be strongly positively improved by adding links.

I might post these things to discourse to try to get some of the things to make a "nix development guide" mdbook site happen. On a broad level, a remarkable amount of contributor frustration is caused by this communication gap. The lack of meta issue tracker is also very painful since it would be useful to ask for help for these things, but they're not written down in a coherent place to actually do them.

21:13:48
@jade_:matrix.org@jade_:matrix.org cc raitobezarius as i have mentioned this a couple of times 21:20:46
@jade_:matrix.org@jade_:matrix.orgoh, another one, the website needs to have the "community" page split from the "teams" information, going to go file an issue for that one21:37:37
@jade_:matrix.org@jade_:matrix.org(because i don't really think "governance" to be the same category as "where is social stuff")21:38:14
@jade_:matrix.org@jade_:matrix.org *

infinisil: re this: https://github.com/NixOS/nixpkgs/pull/270696#discussion_r1412898648

this is emblematic of a larger set of problems we have:

  • 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.
  • Relatedly, we need to write these vision documents down.
  • We don't have a https://rustc-dev-guide.rust-lang.org/ for Nix, and we need one desperately. We should make one and start moving things to it. (n.b. I spot https://nix.dev/contributing/documentation/ now but this should be one website for all Nix things with all the vision for all the pieces on it together, both code and docs, imo)
  • We don't have a repo to file meta issues like I am talking about here, and we need one. Another issue that should be filed in there is "hydra notifications for failed maintained packages", for example.
  • All the places that docs go have different stylesheets and don't link to each other, both as deep links and even shallow links. This gives the impression that they're not part of a coherent ecosystem with one responsible set of people.
  • Our current docs splitting work is partially counterproductive due to this lack of links; but would be strongly positively improved by adding links.

I might post these things to discourse to try to get some of the things to make a "nix development guide" mdbook site happen. On a broad level, a remarkable amount of contributor frustration is caused by this communication gap. The lack of meta issue tracker is also very painful since it would be useful to ask for help for these things, but they're not written down in a coherent place to actually do them.

21:47:38
@raitobezarius:matrix.orgraitobezarius
In reply to @jade_:matrix.org

infinisil: re this: https://github.com/NixOS/nixpkgs/pull/270696#discussion_r1412898648

this is emblematic of a larger set of problems we have:

  • 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.
  • Relatedly, we need to write these vision documents down.
  • We don't have a https://rustc-dev-guide.rust-lang.org/ for Nix, and we need one desperately. We should make one and start moving things to it. (n.b. I spot https://nix.dev/contributing/documentation/ now but this should be one website for all Nix things with all the vision for all the pieces on it together, both code and docs, imo)
  • We don't have a repo to file meta issues like I am talking about here, and we need one. Another issue that should be filed in there is "hydra notifications for failed maintained packages", for example.
  • All the places that docs go have different stylesheets and don't link to each other, both as deep links and even shallow links. This gives the impression that they're not part of a coherent ecosystem with one responsible set of people.
  • Our current docs splitting work is partially counterproductive due to this lack of links; but would be strongly positively improved by adding links.

I might post these things to discourse to try to get some of the things to make a "nix development guide" mdbook site happen. On a broad level, a remarkable amount of contributor frustration is caused by this communication gap. The lack of meta issue tracker is also very painful since it would be useful to ask for help for these things, but they're not written down in a coherent place to actually do them.

note that we recently got (but also forgotten) room for meta discussions without involving #foundation:nixos.org that is #platform-governance:nixos.org
21:50:58
@jade_:matrix.org@jade_:matrix.orgi see am in there :D21:51:12
@jade_:matrix.org@jade_:matrix.org * i see i am in there :D21:51:15
@jade_:matrix.org@jade_:matrix.orgmatrix is not a work item tracker21:51:28
@jade_:matrix.org@jade_:matrix.orgsome of this stuff is legitimately just a matter of doing the work21:51:44
@raitobezarius:matrix.orgraitobezariusagreed21:52:17
@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
@infinisil:matrix.orginfinisil jade_: Maybe we just need more page splitting, more overviews and more cross-linking in the markdown files 22:06:51
@jade_:matrix.org@jade_:matrix.orgyeah, I think mdbook would be nice for search among other things22:07:04
@jade_:matrix.org@jade_:matrix.orglike, having a nice sidebar also22:07:14
@jade_:matrix.org@jade_:matrix.orgbecause it's harder to do page splitting if you don't have nice search and navigation22:07:32
@infinisil:matrix.orginfinisilI 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 manuals22:08:11
@infinisil:matrix.orginfinisil * 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 manuals22:08:20
@jade_:matrix.org@jade_:matrix.org ah yeah, I am definitely not in favour of putting it in the user manual 22:08:35
@infinisil:matrix.orginfinisilThough using the GitHub markdown rendering is also kind of nice because it's one less thing to worry about and maintain22:09:05
@jade_:matrix.org@jade_:matrix.orgit's useful to delineate this because the style of writing for user manuals and contributor-only docs is rather different22:09:13

Show newer messages


Back to Room ListRoom Version: 6