!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

Load older messages


SenderMessageTime
13 Jun 2023
@julienmalka:matrix.orgJulien changed their display name from JulienMalka (stop speaking german when) to Julien (stop speaking german when).14:53:49
@federicodschonborn:matrix.org@federicodschonborn:matrix.org changed their profile picture.20:55:52
@julienmalka:matrix.orgJulien changed their display name from Julien (stop speaking german when) to Julien.21:05:24
14 Jun 2023
@hexa:lossy.networkhexa left the room.16:14:58
@zmitchell:matrix.org@zmitchell:matrix.org
In reply to @pennae:matrix.eno.space
https://github.com/NixOS/nixpkgs/pull/237557 there we go. nixos manual sans docbook
It was at this point I realized I never made a "This Month in Nix Docs" for May 🤦‍♂️
16:20:26
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @pennae:matrix.eno.space
we've got nixpkgs mostly done, just needs a few more changes to nixdoc that we'll take care of before too long (hopefully)
What changes are you thinking of?
20:26:42
@pennae:matrix.eno.spacepennae
In reply to @asymmetric:matrix.dapp.org.uk
What changes are you thinking of?
basically this sans escaping https://github.com/pennae/nixpkgs/blob/nixpkgs-manual-nrd/pkgs/tools/nix/nixdoc/default.nix
20:28:25
@pennae:matrix.eno.spacepennaeescaping is only in there for diff reasons20:28:33
@asymmetric:matrix.dapp.org.ukasymmetricCool, let me know when you have a PR ready :)20:34:37
@pennae:matrix.eno.spacepennaehopefully soon20:34:50
@pennae:matrix.eno.spacepennaewant 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.spacepennae
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.spacepennaewhat 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.spacepennaeie, a lot all over 😅18:42:18
@pennae:matrix.eno.spacepennae 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.spacepennaeeither way, ¬docbook first. then that's finally done :D19:26:46
16 Jun 2023
@pennae:matrix.eno.spacepennaeshould 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

Show newer messages


Back to Room ListRoom Version: 6