!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

382 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 70 Servers

Load older messages


SenderMessageTime
27 Jan 2024
@jade_:matrix.org@jade_:matrix.org
In reply to @qyriad:matrix.org
They're missing a lot but also they're the only real place that explains callPackage which is essential to understanding Nixpkgs
including in reference docs. there are no callPackage reference docs (!)
00:12:03
@jade_:matrix.org@jade_:matrix.org 9999years wrote some docs for it but they were in a pr that was rejected for containing guide level docs 00:12:52
@jade_:matrix.org@jade_:matrix.org(in nixpkgs)00:13:01
@9999years:matrix.org@9999years:matrix.orgtheoretically i could've moved them over to nix.dev but i don't think the signposting is good enough for anyone to find them yet00:13:49
@9999years:matrix.org@9999years:matrix.orgi also want to get this resolved before adding more 'guide' material https://github.com/NixOS/nix.dev/issues/84500:21:33
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @jade_:matrix.org
9999years wrote some docs for it but they were in a pr that was rejected for containing guide level docs
I actually started messing around with that and got stuck in a rabbit hole to refactor callPackage...
02:09:23
@infinisil:matrix.orginfinisil
In reply to @jade_:matrix.org
9999years wrote some docs for it but they were in a pr that was rejected for containing guide level docs
This is the PR: https://github.com/NixOS/nixpkgs/pull/270696
I think it's dishonest to call that rejected. I just said that part of that PR should go to nix.dev instead. I even mentioned that the content is looking good.
03:45:53
@infinisil:matrix.orginfinisilBtw I'm fairly lenient with documentation (at least recently). I don't really care about how stuff is written down exactly. I just check some basic stuff like if it's in the right place, if it's correct, etc. As long as that's the case, I'm willing to merge doc changes03:52:45
@infinisil:matrix.orginfinisilThis is in contrast to actual interface changes in the code, which are full of intricacies that we can't easily revert once committed. So I take much more care in reviewing such PRs :)03:54:31
@charles:computer.surgeryCharleshttps://github.com/NixOS/nixpkgs/pull/264621#issuecomment-1910806642 this kind of thing should probably go in the nixos manual shouldn't it? (i thought i'd ask here first since i don't want to comment on this PR just to be wrong lol)04:34:02
@jade_:matrix.org@jade_:matrix.orgI think that was a misread/miscommunication then, sorry about that.05:05:50
@dooy:matrix.org@dooy:matrix.org changed their display name from Dooygoy to stablejoy.13:37:38
@lehmanator:gnulinux.club@lehmanator:gnulinux.club removed their profile picture.16:53:50
@lehmanator:gnulinux.club@lehmanator:gnulinux.club removed their display name Sam Lehman.17:02:02
@lehmanator:gnulinux.club@lehmanator:gnulinux.club left the room.17:05:08
28 Jan 2024
@infinisil:matrix.orginfinisil
In reply to @jade_:matrix.org
I think that was a misread/miscommunication then, sorry about that.
All good ❤️
03:01:42
@ncfavier:matrix.orgncfavier changed their profile picture.14:04:10
29 Jan 2024
@getpsyched:matrix.orggetpsyched joined the room.00:53:20
@lehmanator:tchncs.deSam Lehman joined the room.10:59:21
@lehmanator:tchncs.deSam Lehman set a profile picture.11:06:03
@brian:bmcgee.ie@brian:bmcgee.ie left the room.14:14:05
31 Jan 2024
@federicodschonborn:matrix.org@federicodschonborn:matrix.org changed their profile picture.03:36:23
@federicodschonborn:matrix.org@federicodschonborn:matrix.org changed their profile picture.06:22:01
@ryan4yi:matrix.orgRyan Yin joined the room.09:14:07
1 Feb 2024
@deightz:matrix.orgdeightz joined the room.04:05:19
@i97henka:matrix.orghenrik-chI won't make the meeting today - sorry and have a good session!14:26:40
3 Feb 2024
@raboof:matrix.orgraboof changed their display name from raboof to raboof @FOSDEM.07:38:48
4 Feb 2024
@bjth:matrix.orgBryan Honof changed their profile picture.11:31:25
@raboof:matrix.orgraboof changed their display name from raboof @FOSDEM to raboof.17:41:37
@fractivore:cyberia.club@fractivore:cyberia.club

I would like to help with documentation. I have put some time into learning Nix and NixOS but would still consider myself a beginner-level learner. Helping with documentation is a recommended starting contribution, and also seems like an efficient way to take excellent notes as I go that can also benefit others.

But also, I really like diagramming things, and I've noticed there is a shortage of visual documentation components. I am looking for some guidance on what might be some good things to diagram that people have noticed or thought of. I'm thinking:

  • Organizational graphs (maybe something about store layout)
  • Mnemonic devices ( Venn-diagrams pertaining to use-cases of flakes vs modules, or something like that )
  • Really, my goal is abundant and diverse visual learning aids. Doesn't have to stop at visual media even.
18:01:41

Show newer messages


Back to Room ListRoom Version: 6