Nix Documentation | 401 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 80 Servers |
| Sender | Message | Time |
|---|---|---|
| 16 Mar 2024 | ||
| Oh wait, I don't think that time is apples to apples:
| 05:22:56 | |
| The manual is already built as the inputDerivation to that derivation. | 05:23:37 | |
| Nix is so hard to benchmark with the all the caching and indirection. | 05:24:40 | |
ryantm: Not sure what you mean, I'm pretty sure nix-build --check pkgs/top-level/release.nix -A manual is the actual build, it's not just a dependency | 05:25:23 | |
| And the command you pasted failed | 05:25:33 | |
| Ah yeah, oops. Okay. | 05:25:53 | |
(gotta build without --check first.. yeah not a great interface) | 05:25:58 | |
| Redacted or Malformed Event | 05:26:59 | |
| Updated the gist again. Looks like the nixpkgs closure is bigger, but the nixpkgs closure matters less. | 05:28:28 | |
| Could you post the results in the github issue? I'm overall not very convinced that this is worth it though ๐ | 05:29:31 | |
| * Could you post the results in the github issue (ideally a nice markdown table with the numbers)? I'm overall not very convinced that this is worth it though ๐ | 05:29:46 | |
| Yeah there's a lot of hate for C. | 05:30:00 | |
| and your thing is already working mostly, though not multipage. | 05:30:23 | |
| Seems reasonable not to switch. | 05:30:26 | |
| I feel kind of bad, you worked on this for so long ๐ | 05:31:07 | |
| I'll take down my multipage manual when we publish official ones. | 05:31:08 | |
| No big deal, I still love the project independent of Nix accepting it. | 05:31:34 | |
| I use it for all my projects and blogs and stuff. | 05:31:44 | |
| I love the easy interface with no config I came up with. | 05:31:59 | |
In reply to @ryantm:matrix.orgI've been told the code is literally there for it, though. so we seem to need to do some wiring.ย | 07:41:14 | |
| 09:23:50 | ||
| (infinisil requested our presence :D) | 09:24:07 | |
In reply to @rina/:matrix.org What would you be interested in taking a closer look at? It would also help knowing what you may have had experience with already, to find something that wonโt overwhelm or frustrate you too quickly. Feel free to DM me if you donโt want this public. Not everything needed to get started is written down nicely yet, so I can offer a brief guided tour of the various construction sites. | 14:06:41 | |
| hm off the top of my head, there are gaps around the trivial script writers - both in terms of documentation and the options they provide | 14:12:30 | |
| i mainly use nix outside nixos, and much of my packaging experience is with C/C++ and cmake. maybe more documentation on dealing with cmake external projects would be useful too | 14:14:06 | |
| but these are just items i have had the need for in the past, I can try to help out elsewhere if able | 14:24:07 | |
| I'm actually heading to sleep now (in Australia), but I will read any replies tomorrow | 14:24:28 | |
In reply to @rina/:matrix.org There is a wealth of information here: https://nixos.wiki/wiki/C Mostly written by @Mic92 in past years AFAIK. Would be great to have that closer to the code, because all of that is Nixpkgs material. We still haven't really figured out how to organise troubleshooting tips and other guide-like material across the ecosystem though. The last state of affairs was that we converged on the idea that it should be a bit like what Johannes Kirschbauer @hsjobeki proposes for function documentation, but for guides: have a uniform format used across Nix, Nixpkgs, and NixOS, and present that in one place, annotated with tags and searchable. But that is a lot of "should", and will require thinking about the structure of the manuals, and moving around lots of text. | 15:27:15 | |
In reply to @rina/:matrix.org Those were recently improved:
But there's definitely still work to do. Ideally we'd also render that stuff directly from the source. At least there is no duplication any more. I can imagine danielsidhion could help with reviews. | 15:31:48 | |
In reply to @rina/:matrix.org* There is a wealth of information here: https://nixos.wiki/wiki/C Mostly written by @Mic92 in past years AFAIK. Would be great to have that closer to the code, because all of that is Nixpkgs material. We still haven't really figured out how to organise troubleshooting tips and other guide-like material across the ecosystem though. The last state of affairs was that we converged on the idea that it should be a bit like what Johannes Kirschbauer @hsjobeki proposes for function documentation, but for guides: have a uniform format used across Nix, Nixpkgs, and NixOS, and present that in one place, annotated with tags and searchable. But that is a lot of "should", and will require thinking about the structure of the manuals, moving around lots of text, and building automation for presenting the result. | 15:32:40 | |