!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

405 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

Load older messages


SenderMessageTime
6 Nov 2024
@getpsyched:matrix.orggetpsyched Let's get on the same page about a few non-variables (mostly reiterating from the conversation we had),
  1. These release notes will be in the highlights section

  2. 2-3 sentences per release note (and how many of those?)

Same goes for the other documentation (non-wiki) release notes
18:53:31
@getpsyched:matrix.orggetpsychedAs discussed, we won't keep a criteria for the content itself, and that can be decided internally by both teams18:54:21
@getpsyched:matrix.orggetpsyched Let's get on the same page about a few non-variables (mostly reiterating from the conversation we had),
  1. These release notes will be in the highlights section

  2. 2-3 sentences per release note (and how many of those?)

Same goes for the wiki's release notes
18:56:54
@getchoo:matrix.orggetchoo joined the room.21:26:55
@getchoo:matrix.orggetchoo
In reply to @pyrox:pyrox.dev
whoa getchoo reference 🤯
šŸ˜„
21:27:16
@pyrox:pyrox.devdish [Fox/It/She]
In reply to @getchoo:matrix.org
šŸ˜„
šŸ‘ļø
21:40:36
13 Nov 2024
@inayet:matrix.orgInayet joined the room.22:16:45
19 Nov 2024
@federicodschonborn:matrix.org@federicodschonborn:matrix.org changed their display name from Federico DamiÔn Schonborn to LEGO® Worm™.01:06:27
20 Nov 2024
@inayet:matrix.orgInayet removed their profile picture.00:59:35
@adam:robins.wtf@adam:robins.wtf joined the room.16:53:28
@adam:robins.wtf@adam:robins.wtfHi 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-writeText16:55:26
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @adam:robins.wtf
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
I’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
@adam:robins.wtf@adam:robins.wtfIf anything I'd rather the equivalent be collapsed and the example visible by default :)16:58:05
@fricklerhandwerk:matrix.orgfricklerhandwerkI’ll gladly merge PRs!17:14:13
@adam:robins.wtf@adam:robins.wtfwhen 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
@fricklerhandwerk:matrix.orgfricklerhandwerk 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
@fricklerhandwerk:matrix.orgfricklerhandwerk * 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
@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.lgbt@nerves:bark.lgbt 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.org@nullcube:matrix.org 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

Show newer messages


Back to Room ListRoom Version: 6