Nix Documentation | 401 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 79 Servers |
| Sender | Message | Time |
|---|---|---|
| 20 Nov 2024 | ||
| Hi friends. I noticed in the nixpkgs manual that all the trivial builder examples are collapsed, but the code blocks showing equivalents are not. This makes for a slightly confusing presentation. https://nixos.org/manual/nixpkgs/unstable/#trivial-builder-writeText | 16:55:26 | |
In reply to @adam:robins.wtfI’m not even sure why examples are collapsed to begin with. Hard to find anything that way. I’d be in favor of changing it | 16:57:35 | |
| If anything I'd rather the equivalent be collapsed and the example visible by default :) | 16:58:05 | |
| I’ll gladly merge PRs! | 17:14:13 | |
| when i find some time i'll try and figure out how to do so, unless someone can point me in the right direction :) | 18:00:53 | |
I’d take a look at the website’s HTML and then search for css files in doc to see where it’s styled.If examples are in I’d also search for that inside the nixos-render-docs source (lives in some subdir in Nixpkgs) | 18:07:45 | |
* I’d take a look at the website’s HTML and then search for css files in doc to see where it’s styled.
If examples are in<details> I’d also search for that inside the nixos-render-docs source (lives in some subdir in Nixpkgs) | 18:08:10 | |
Essentially try to trace back the output to the various sources and then twiddle the knobs. There’s a devmode command in the shell inside doc that will show live updates | 18:09:18 | |
| 21 Nov 2024 | ||
| 02:51:49 | ||
| 22 Nov 2024 | ||
| 17:51:57 | ||
| 25 Nov 2024 | ||
| 10:06:22 | ||
| A few months ago people were working on paginating the manual. How is that going? | 10:29:48 | |
| 29 Nov 2024 | ||
In reply to @noob_tea:matrix.org People is getpsyched with some eyeballs from me. It's still going and deeply in the weeds with preliminary work. You can follow progress in the work log. I'm not sure it will fully snap together by the end of the timeline mid December, but the most important parts of making a page split possible without disrupting workflows will fairly certainly get done. | 00:35:17 | |
In reply to @fricklerhandwerk:matrix.orgwow, that is very detailed | 08:42:44 | |
| thanks! | 08:42:49 | |
| 17:39:49 | ||
| Hi! I've stumbled on https://github.com/NixOS/nixpkgs/actions/runs/12071127791/job/33662163276?pr=341598 and I don't really understand what must be done in this new module for the NixOS manual to build properly. Is there some kind of documentation for how to properly add these redirects for modules documentation? | 17:44:32 | |
| 18:30:24 | ||
| 30 Nov 2024 | ||
| You have to add entries to
Rationale and design documentation: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/ni/nixos-render-docs/README.md Once the page-split is performed, you'll also have to consider the output path of the element referred to by
| 15:14:04 | |
| 2 Dec 2024 | ||
| 19:59:19 | ||
| 3 Dec 2024 | ||
| 06:06:36 | ||
| 7 Dec 2024 | ||
| 20:23:19 | ||
| 9 Dec 2024 | ||
| 08:01:46 | ||
| 14 Dec 2024 | ||
| 22:42:39 | ||
| Anyone know if there is a way to generate the Appendix A page for nixpkgs (and also home-manager, nix-darwin) using the local pinned version in my flake? I don't update my flake inputs too often, so sometimes the online Appendix A pages drift from my local nixpkgs | 22:44:40 | |
| yut0: Are you maybe looking for `man configuration.nix`? | 23:46:31 | |
| 15 Dec 2024 | ||
| Oh hell yeah thank you | 11:19:39 | |
| Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager? | 11:21:27 | |
| yut0: `man home-configuration.nix` I have no idea about generation of the html pages I'm sure someone else will chime in though. | 11:26:28 | |
In reply to @yut0:matrix.orgFor figuring out how the appendix is built, check the Nixpkgs repo in doc/default.nix and follow the call graph from there. Home Manager uses the same source code, check its source code starting from default.nix, there’s a doc attribute that builds the module documentation | 17:36:09 | |