Nix Documentation | 418 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 83 Servers |
| Sender | Message | Time |
|---|---|---|
| 27 Jan 2024 | ||
In reply to @jade_:matrix.orgThis 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 | |
| Btw 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 changes | 03:52:45 | |
| This 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 | |
| https://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 | |
| I think that was a misread/miscommunication then, sorry about that. | 05:05:50 | |
| 13:37:38 | ||
| 16:53:50 | ||
| 17:02:02 | ||
| 17:05:08 | ||
| 28 Jan 2024 | ||
In reply to @jade_:matrix.orgAll good ❤️ | 03:01:42 | |
| 14:04:10 | ||
| 29 Jan 2024 | ||
| 00:53:20 | ||
| 10:59:21 | ||
| 11:06:03 | ||
| 14:14:05 | ||
| 31 Jan 2024 | ||
| 03:36:23 | ||
| 06:22:01 | ||
| 09:14:07 | ||
| 1 Feb 2024 | ||
| 04:05:19 | ||
| I won't make the meeting today - sorry and have a good session! | 14:26:40 | |
| 3 Feb 2024 | ||
| 07:38:48 | ||
| 4 Feb 2024 | ||
| 11:31:25 | ||
| 17:41:37 | ||
| 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:
| 18:01:41 | |
| I was thinking about starting with some of the diagrams in https://edolstra.github.io/pubs/phd-thesis.pdf , like taking them as a starting point, determining if anything has changed since the thesis was released, then building diagrams (as code, preferably) with a little more color or whatever. Then going from there. | 18:04:01 | |
| Has anybody ever looked at a doc and said "I wish there were less diagrams"? 🤔 | 18:04:42 | |
| Yes, but only when they were bad =P Go for it, the docs could definitely use some visual aids | 18:05:37 | |
| Diagrams are welcome! Feel free to ask if you need help reviewing them or with anything else | 18:23:05 | |
| One thing I'm wondering - if I want to do diagrams as code, are the docs opinionated as to what language I'd do that in? I've used that python diagrams as code library a lot. But also webGL... Could do Go or something..... | 20:15:07 | |
| WebGL is awful heavy, idk if rendering to html canvases would be good at all... Python diagrams would actually make maintaining the diagrams pretty easy but I don't know how well it would integrate with the docs. | 20:17:52 | |