!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem84 Servers

Load older messages


SenderMessageTime
14 Dec 2023
@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
@jade_:matrix.org@jade_:matrix.orgi wonder if we could reuse the nix.dev code somehow without causing ourselves too much pain?22:09:25
@infinisil:matrix.orginfinisil I think ideally all .md files in Nixpkgs would be collected somehow and rendered together 22:10:20
@infinisil:matrix.orginfinisil (well, user docs are also written in .md, those shouldn't be included obviously) 22:11:16
@infinisil:matrix.orginfinisilOh, but alternatively, what if the render pipelines are separate, but the website puts them into a single document22:11:54
@infinisil:matrix.orginfinisil 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:matrix.orginfinisilThis is generally what I think we should have: A single page that collects materials from different repos22:13:22
@infinisil:matrix.orginfinisilAnd actually we did make a step in that direction with nix.dev: https://nix.dev/reference/nix-manual22:13:41
@infinisil:matrix.orginfinisilI'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@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@jade_:matrix.orgimage.png
Download image.png
22:19:05
@jade_:matrix.org@jade_:matrix.orgit would be really nice to have a version selector on-page with these: 22:19:06
@jade_:matrix.org@jade_:matrix.orgoverall we need more top bar nav in all our stuff :D22:19:20
@infinisil:matrix.orginfinisilUltimately it boils down to needing more resources22:19:58
@infinisil:matrix.orginfinisilAnd 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
@jade_:matrix.org@jade_:matrix.orgyeah, for sure. I think that it would be useful to have some meta-tracking of mini projects to do to improve this22:20:29
@jade_:matrix.org@jade_:matrix.orgso we can start pointing at the work pile and giving it to others22:20:45
@infinisil:matrix.orginfinisilJust need to define "others" 😅22:21:15
@infinisil:matrix.orginfinisilNobody really wants to do that kind of work22:21:21
@jade_:matrix.org@jade_:matrix.organyone not in the in-group, I think we can get help from people who haven't met irl at nixcon on this :P22:21:47
@infinisil:matrix.orginfinisilIt does take a lot of time and is not very rewarding work, it's really hard to get anybody to do this22:22:31
@infinisil:matrix.orginfinisilI'm the exception because I get paid for this, definitely not the norm22:22:58
@jade_:matrix.org@jade_:matrix.org

yeah. i guess, the thing is, currently the improvement ideas are on matrix which is very ephemeral, and so it's very much just what is in everyone's head, and ....

I have a few friends who have worked on Nix things but have had bad experiences having their things bikeshed (sometimes because of misalignment with vision), and so it would be good to have a list of improvements that are explicitly encouraged and on-roadmap, to give newer people more independent agency on doing them.

22:25:22
@infinisil:matrix.orginfinisilYeah agreed. The docs team is doing that to a degree with docs, but it could be done better.22:27:35
@infinisil:matrix.orginfinisilIt's much better than a year ago though :)22:27:56
@philiptaron:matrix.orgPhilip Taron (UTC-8)
In reply to @infinisil:matrix.org
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)
I so wish that we could acquire https://github.com/nix/ from the current user. More than even a domain name, github is the locus of Nix activity.
22:42:41
@infinisil:matrix.orginfinisil Philip Taron: Just sent that user an email a couple weeks ago, haven't heard back though :( 22:43:26

Show newer messages


Back to Room ListRoom Version: 6