!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

422 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
14 Jun 2023
@pennae:matrix.eno.space@pennae:matrix.eno.spacehopefully soon20:34:50
@pennae:matrix.eno.space@pennae:matrix.eno.spacewant to be done with this stuff tbh20:34:59
@asymmetric:matrix.dapp.org.ukasymmetricI’ve just added snapshot testing, so we’ll need to update the snapshot in the PR too20:35:29
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @asymmetric:matrix.dapp.org.uk
I’ve just added snapshot testing, so we’ll need to update the snapshot in the PR too
should be no problem. will have to see if we need any more changes to make the docs port feasibly reviewable without changing the output too much, but looks like that should be it (or at least close)
21:05:13
15 Jun 2023
@badele:matrix.orgBruno Adele joined the room.07:06:40
@mon:tchncs.depneumatic joined the room.16:39:53
@pennae:matrix.eno.space@pennae:matrix.eno.spacewhat kind of stuff still needs to be done on the docs infra side, assuming that the docbook transition is over and nixos-render-docs is provisionally complete?18:08:08
@infinisil:matrix.orginfinisil pennae: I'd say the ultimate goal should be for the documentation to live right next to the relevant code in Nixpkgs and Nix, and for the nix.dev (or even better, nixos.org) to just be rendering of that, so that we don't actually have any content in nix.dev itself 18:35:18
@infinisil:matrix.orginfinisil So that e.g. if you want to write some new lib function, you can write the implementation, reference docs, potential tutorials/guides/explanations right next to it 18:36:44
@infinisil:matrix.orginfinisil pennae: Other minor more short-term bits is figuring out automatic redirects for nix.dev, see https://github.com/NixOS/nix.dev/issues/522 18:38:25
@infinisil:matrix.orginfinisil pennae: There's also an infrastructure label in the project board: https://github.com/orgs/NixOS/projects/15/views/1?filterQuery=topic%3AInfrastructure 18:39:42
@pennae:matrix.eno.space@pennae:matrix.eno.spaceie, a lot all over 😅18:42:18
@pennae:matrix.eno.space@pennae:matrix.eno.space colocating docs sounds a lot like rustdoc and if repl integration is wanted we should really get the docs syntax rfc done first, and then fold everything into nix itself 18:48:26
@pennae:matrix.eno.space@pennae:matrix.eno.spaceeither way, ¬docbook first. then that's finally done :D19:26:46
16 Jun 2023
@pennae:matrix.eno.space@pennae:matrix.eno.spaceshould we just merge the dedocbooking pt 1 later or wait for roberth to review it too09:09:38
@jtojnar:matrix.orgJan Tojnar looks like nixos/doc/manual/man-pages.xml has been forgotten? 12:36:32
@jtojnar:matrix.orgJan Tojnarbut that was for one of the previous PR12:36:54
@jtojnar:matrix.orgJan Tojnar * but that was for one of the previous PRs12:36:56
@i97henka:matrix.orghenrik-chHappy Friday all - https://vadimkravcenko.com/shorts/proper-documentation/ Not 100% applicable to what we do but still worth a read I think.13:28:05
@brian:bmcgee.ie@brian:bmcgee.ieI'm spending some time going through the open PR's in nix.dev. I'm starting with the dependabot PRs. It looks like I have the power to close issues, so I'm gonna close those I think are no longer relevant unless anyone objects?13:33:41
@brian:bmcgee.ie@brian:bmcgee.ieLike this for example: https://github.com/NixOS/nix.dev/pull/32913:33:49
@brian:bmcgee.ie@brian:bmcgee.ie myst-parser in master is now 1.0.0 13:34:09
@brian:bmcgee.ie@brian:bmcgee.ie Managed to close a few and merged the cachix action change. The remainder are conflicts with the poetry lock file 13:44:46
@brian:bmcgee.ie@brian:bmcgee.ieGonna hunt for some other low hanging fruit13:45:04
@brian:bmcgee.ie@brian:bmcgee.ieThere's some PR's like this one https://github.com/NixOS/nix.dev/pull/197 which still seem useful but I don't know how they fit into the latest docs thinking / recent work on learning journey etc13:53:34
@brian:bmcgee.ie@brian:bmcgee.ieIs there someone who should be a reviewer on PRs like this by default? 13:54:10
@brian:bmcgee.ie@brian:bmcgee.ieMaybe a group PR review session for nix.dev at some point would help get through the backlog and ping people to resolve conflicts as necessary. I don't want to prod someone to resolve a conflict just for it to get rejected 13:58:31
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @jtojnar:matrix.org
looks like nixos/doc/manual/man-pages.xml has been forgotten?
oh, that should go away too
17:24:29
@sandro:supersandro.deSandro
In reply to @brian:bmcgee.ie
There's some PR's like this one https://github.com/NixOS/nix.dev/pull/197 which still seem useful but I don't know how they fit into the latest docs thinking / recent work on learning journey etc
we shouldn't recommend this. Debians version is, as usual, very out of date and maintenance is lacking
21:17:56
@sandro:supersandro.deSandroalso they disable the sandbox by default which is completely unsupported on x86_64-linux and will cause issues https://salsa.debian.org/debian/nix/-/blob/master/debian/nix.install.files/nix.conf#L521:19:14

Show newer messages


Back to Room ListRoom Version: 6