!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

417 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
13 May 2024
@philiptaron:matrix.orgPhilip Taron (UTC-8) I see that pkgs/top-level/release.nix is the entry point for doc/default.nix. Other than the default variable there, I don't see where nixpkgs is actually filled out. 15:55:48
@infinisil:matrix.orginfinisil Philip Taron (UTC-8): That nixpkgs is set by Hydra :) 16:51:18
@infinisil:matrix.orginfinisil I think I've seen some recent discussions about exposing doc/default.nix from pkgs, but I don't think there was a reason against not doing that 16:52:08
@infinisil:matrix.orginfinisilSeems fine to me!16:52:12
@infinisil:matrix.orginfinisil fricklerhandwerk: (unrelated to the above): We created @NixOS/documentation-reviewers as (docs team - Valentin) to limit your notifications, but I guess we don't need this anymore, right? If so I can remove it 16:55:57
@infinisil:matrix.orginfinisilNow opened https://github.com/NixOS/nix.dev/pull/978 to remove the mention of documentation-reviewers17:07:37
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @philiptaron:matrix.org
I see that pkgs/top-level/release.nix is the entry point for doc/default.nix. Other than the default variable there, I don't see where nixpkgs is actually filled out.
This is a thoroughly cursed code path, I also ran into it recently. I think there is also some passing happening in flake.nix
17:30:42
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @infinisil:matrix.org
Now opened https://github.com/NixOS/nix.dev/pull/978 to remove the mention of documentation-reviewers
There’s also something in the Nixpkgs contributing guide though?
17:31:32
@philiptaron:matrix.orgPhilip Taron (UTC-8)
In reply to @fricklerhandwerk:matrix.org
This is a thoroughly cursed code path, I also ran into it recently. I think there is also some passing happening in flake.nix
Thanks for the pointer. I do see that nixpkgs = self now. Good to know...
17:35:09
@infinisil:matrix.orginfinisil
In reply to @fricklerhandwerk:matrix.org
There’s also something in the Nixpkgs contributing guide though?
Adding to https://github.com/NixOS/nixpkgs/pull/311414
17:56:31
@infinisil:matrix.orginfinisil Philip Taron (UTC-8): https://github.com/NixOS/hydra/blob/998df1657e7e9bd3c2d54f8106eae5a325e17e02/src/script/hydra-eval-jobset#L294-L309 18:35:34
@infinisil:matrix.orginfinisildocumentation-reviewers team is now gone :)19:26:04
@philiptaron:matrix.orgPhilip Taron (UTC-8)
In reply to @infinisil:matrix.org
Seems fine to me!
https://github.com/NixOS/nixpkgs/pull/311459 -- it was a little easier than I expected.
20:23:38
@philiptaron:matrix.orgPhilip Taron (UTC-8)It's marked Draft because I fell afoul of the "Don20:25:32
@philiptaron:matrix.orgPhilip Taron (UTC-8) * It's marked Draft because I fell afoul of the "Don't reach outside of your directory" rule in the by-name checker: https://github.com/NixOS/nixpkgs/actions/runs/9069302338/job/24918546803?pr=31145920:25:53
@philiptaron:matrix.orgPhilip Taron (UTC-8) * It's marked Draft because I fell afoul of the "Don't reach outside of your directory" rule in the by-name checker: https://github.com/NixOS/nixpkgs/actions/runs/9069363512/job/24918746093?pr=31145920:32:26
@infinisil:matrix.orginfinisil Ahh right 😅 23:13:54
14 May 2024
@infinisil:matrix.orginfinisil changed their profile picture.17:44:44
@fricklerhandwerk:matrix.orgfricklerhandwerkI'm hanging out in https://jitsi.lassul.us/nix-documentation for office hours18:58:47
@fricklerhandwerk:matrix.orgfricklerhandwerkFeel free to join and chat or hack on docs!19:03:04
@stablejoy:matrix.org@stablejoy:matrix.orgId love to! Im on trip atm but these hours are also good for future office hours!19:17:56
15 May 2024
@phaer:matrix.orgphaerI remember seeing a pad with a table comparing different markdown implementations in the context of how useful they would be for nix(os) documentation. But I can't find it anymore. Does anyone have a link and/or the answer on which implementation has been chosen in the end?07:21:03
@phaer:matrix.orgphaerSeems to be markdown-it-py, according to https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/tools/nix/nixos-render-docs/default.nix#L63 :)07:37:52
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phaer:matrix.org
I remember seeing a pad with a table comparing different markdown implementations in the context of how useful they would be for nix(os) documentation. But I can't find it anymore. Does anyone have a link and/or the answer on which implementation has been chosen in the end?

danielsidhion made an overview here: https://ethercalc.net/dc4vcnnl8zv0

Also linked from here: https://discourse.nixos.org/t/a-roadmap-for-the-documentation-ecosystem/42328

08:09:37
@fricklerhandwerk:matrix.orgfricklerhandwerkBTW it's documentation office hours again: https://jitsi.lassul.us/nix-documentation08:16:00
@raghavsood:matrix.orgraghavsood joined the room.08:28:19
@raghavsood:matrix.orgraghavsood set a profile picture.08:38:25
@soenkeklinger:matrix.orgSoenke KlingerShould I use the stable or the unstable manual when I place a link from the the Wiki to the manual?14:33:03
@soenkeklinger:matrix.orgSoenke Klinger * Should I use the stable or the unstable manual when I place a link from the the Wiki to the NixOS manual?14:33:59
@infinisil:matrix.orginfinisil Soenke Klinger: Preferably the stable one 14:39:11

Show newer messages


Back to Room ListRoom Version: 6