!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

380 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
20 Nov 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk 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
@nerves:bark.lgbtJason Odoom changed their profile picture.02:51:49
22 Nov 2024
@numinit:matrix.orgMorgan (@numinit) joined the room.17:51:57
25 Nov 2024
@nullcube:matrix.orgNullCube joined the room.10:06:22
@noob_tea:matrix.orgteaA few months ago people were working on paginating the manual. How is that going?10:29:48
29 Nov 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @noob_tea:matrix.org
A few months ago people were working on paginating the manual. How is that going?

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
@noob_tea:matrix.orgtea
In reply to @fricklerhandwerk: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.

wow, that is very detailed
08:42:44
@noob_tea:matrix.orgteathanks!08:42:49
@misuzu:matrix.orgmisuzu joined the room.17:39:49
@misuzu:matrix.orgmisuzuHi! 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
@lassulus:lassul.uslassulus changed their profile picture.18:30:24
30 Nov 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk

You have to add entries to nixos/doc/manual/redirects.json, which look like this:

  "<identifier>": [
    "index.html#<identifier>",
  ]

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 <identifier>, then the shape will have to be

  "<identifier>": [
    "<path/to/output/location>.html#<identifier>",
  ]
15:14:04
2 Dec 2024
@pyrox:pyrox.devdish [Fox/It/She] changed their profile picture.19:59:19
3 Dec 2024
@getchoo:matrix.orggetchoo changed their profile picture.06:06:36
7 Dec 2024
@tek:tryp.io@tek:tryp.io left the room.20:23:19
9 Dec 2024
@karlericsson:matrix.orgkarlericsson joined the room.08:01:46
14 Dec 2024
@yut0:matrix.orgyut0 joined the room.22:42:39
@yut0:matrix.orgyut0Anyone 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 nixpkgs22:44:40
@toonn:matrix.orgtoonn yut0: Are you maybe looking for `man configuration.nix`? 23:46:31
15 Dec 2024
@yut0:matrix.orgyut0Oh hell yeah thank you11:19:39
@yut0:matrix.orgyut0Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?11:21:27
@toonn:matrix.orgtoonn 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @yut0:matrix.org
Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?
For 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @yut0:matrix.org
Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?
* For 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 tooling, check its source code starting from default.nix, there’s a doc attribute that builds the module documentation
17:36:24
@mel:rnrd.euMel changed their profile picture.21:38:58
18 Dec 2024
@dmiskovic:matrix.org@dmiskovic:matrix.org joined the room.19:37:53
21 Dec 2024
@stablejoy:matrix.org@stablejoy:matrix.org left the room.05:08:24
@dmiskovic:matrix.org@dmiskovic:matrix.org left the room.05:13:53
@stablejoy:matrix.org@stablejoy:matrix.org joined the room.06:43:12
@dimitarnestorov:matrix.orgDimitar joined the room.19:42:45

Show newer messages


Back to Room ListRoom Version: 6