Nix Documentation | 422 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 86 Servers |
| Sender | Message | Time |
|---|---|---|
| 29 Jan 2024 | ||
| 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 | |
| nix.dev seems to have a lot of python stuff, so the https://diagrams.mingrammer.com/ thing should actually be kinda perfect right? | 20:45:54 | |
| Oh I got an idea for my first diagram here: "Map of the Nix Documentation Multiverse" | 21:01:55 | |
| symys: That sounds great! I'd be in favor of Mermaid diagrams, because GitHub supports them natively now | 22:36:16 | |
| And I'd expect sphinx (which is used for nix.dev) to have a plugin for that too | 22:36:43 | |
| 5 Feb 2024 | ||
| Been using mermaid diagrams at a client and have really liked ‘em so far. | 00:31:34 | |
| I also added one to the contributor docs :D https://github.com/NixOS/nixpkgs/blob/86a5d2482eecde9579c2f073e04a14e170ef5e31/CONTRIBUTING.md#staging | 00:43:23 | |
In reply to @infinisil:matrix.orgNice, now I can look at how you did that 😄 I was thinking those commit graphs looked like something that might come in handy! And it just adds some color into the doc right away which is nice! | 12:08:52 | |
| Someone can have a loom at https://github.com/NixOS/nixpkgs/pull/252091 ? | 18:11:31 | |
| 22:45:09 | ||
| 22:46:17 | ||
| 22:46:55 | ||
| 6 Feb 2024 | ||
So I decided to just start going through nix.dev in order and see if anything jumped out at me as worth diagramming. The nix-shell environment occurred to me when nix-shell came up early on. So, I attempted to diagram a little more detail of "what is happening". I was wondering if somebody could check my diagram for accuracy, and suggest improvements as to its accuracy. You can view the diagram in the mermaid live-editor here: https://mermaid.live/edit#pako:eNqtll9r2zAQwL_Kzd2jzdK9DPww2JZCH7YySBgMDJssnRpRWTKSHCd0_e6TZSe2Ezul3QiYWNb97v9JjxHVDKM0ypR1xOFSkHtDimT7PlNMGKROaAXrz5nKFKF0LZzEFO7ELrEblBIo8Q_ckaKUCHZvHRaJxC1KYC0piC3RUpPCShcIDB0REjQHAurIkUiMEur-wIqBWL8h2NSjmh8AUEmsXSLvFK4CgQsp06vFgl_HXCuX1CjuNy7NtWSxdUY_YFIL5jbpdbnrFtJcEvpwgqxyoysnFLZEuGKcLzi-hOHd-q82OTSFUKTjhQ0x1VKb9Ip9wAXnL6b3_KOxN2orjFYFKndcm9zmzH51DFLcf9gJ168P4jiAdAn72hTImdJBMgcipcFWZVMJ8aE87jqlX3RREMVioNrWZH98LbV1waBQP4f4dX6PmZAkHy_Z1YpM6w2yM5Fp5WY-ngieKJtKyUhgFOpW5lJkG9lRRA6BaNsri1ZBGLqW7nwrjS5KB6QmwoXObFzIoqYxRwH8R9TYrnNUN07auggil1x9PLg2BP3UFZhKpfC7HzhJ2dUMSC0pcb9b9kyee-Y5vWcGt4aV740J1Lkq6GFDIMMSFUNFBdpmTnZ2Nna0tkJeCekuoqfJOIjUlhhBculVWHwN6-1qvby5-_Hr-6f17TuPqEqwujIU2StgIX63Wj-EAwV9Bwv-Arumkn5MyyljVCxDY8Zvo4nybPtNM84LkOra-lzeeoyOm3P0DfwZV-BI73M49KZMy01LDmrVSw5LdRyk8SyfyRk68D1o9m7T9HTuDxZwGja6Bo-uPS5Hrg02poajfS4jJ-GcC2j_76n92z6fojgq_IAngvlrTEhpFrkNFt6nNHQTJ1XTLZlqtpLK6dVe0Sh1psI4qkrWX3uilBNp_Soy4bT51l6Nwg3p6S-2Tiw- | 03:01:02 | |
| The diagram is supposed to go with: https://nix.dev/tutorials/first-steps/ad-hoc-shell-environments | 03:01:35 | |