!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

380 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 72 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
15 Mar 2024
@infinisil:matrix.orginfinisil We welcome Johannes Kirschbauer @hsjobeki, author of the accepted RFC 145 and https://noogle.dev/, to the docs team! 🚀 19:42:34
@infinisil:matrix.orginfinisilHomepage PR: https://github.com/NixOS/nixos-homepage/pull/135019:42:58
@grahamc:nixos.org@grahamc:nixos.org joined the room.21:48:35
@infinisil:matrix.orginfinisil ryantm: Would be great if you could synchronise with the docs team a bit more regarding https://github.com/NixOS/nixpkgs/pull/108063, it looks like you want to merge it soon :) 23:28:14
16 Mar 2024
@rina/:matrix.orgkait joined the room.03:35:37
@rina/:matrix.orgkaithello, it would be better if the link to this room was a generic matrix.to instead of via the element app03:38:35
@rina/:matrix.orgkait(on this page https://nixos.org/community/teams/documentation/ )03:38:45
@rina/:matrix.orgkaite.g. https://matrix.to/#/#docs:nixos.org03:39:08
@rina/:matrix.orgkait https://matrix.to/#/#docs:nixos.org 03:39:17
@danielsidhion:nixos.devdanielsidhionI think so03:41:27
@infinisil:matrix.orginfinisil kait/: Agreed! Could you PR this? Source is https://github.com/NixOS/nixos-homepage/blob/main/src/content/teams/11_documentation.mdx 03:42:14
@rina/:matrix.orgkaitsure! thanks for the link :)03:43:16
@ryantm:matrix.orgryantm
In reply to @infinisil:matrix.org
ryantm: Would be great if you could synchronise with the docs team a bit more regarding https://github.com/NixOS/nixpkgs/pull/108063, it looks like you want to merge it soon :)
Mainly I'm trying to get it merged so others can easily try it out and try to do it in the most self contained way so it is low risk and can be ripped out easily.
03:49:14
@infinisil:matrix.orginfinisil ryantm: I guess especially @pennae, who has been saying a lot that nixos-render-docs can already render with multiple pages with some small changes to the code. Furthermore Johannes Kirschbauer @hsjobeki and danielsidhion who have been investigating existing docs rendering tools to see if we could maybe not roll our own tooling at all. Your PR introduces yet another custom-built tool 😅 03:53:55
@infinisil:matrix.orginfinisil I think we need a bit more convergence in docs tooling, so decreasing the different tools. We can still introduce new tools, but then we should also eventually deprecate another. I guess that's what your intending with your mmdoc, to replace nixos-render-docs 03:55:53
@infinisil:matrix.orginfinisilThat could be fine, but then we need to make sure that mmdoc supports everything that nixos-render-docs does and that somebody can maintain it. While nixos-render-docs is also pretty much maintained by just @pennae, it's written in Python, which at least from a superficial look is a lot more accessible than a C code base like your mmdoc 😅03:58:25
@danielsidhion:nixos.devdanielsidhion To add a bit to this - looks like one of the motivations is to introduce a fast docs building tool because the nixos html manual and manpages get built for nixos (depending on the nixos config). I haven't yet dug into why we need to build the html manual for the nixos config at all, but in any case, Johannes Kirschbauer @hsjobeki and I are looking to converge on less tooling mostly for the html part, and focused on the usual web docs experience, not the in-your-os docs experience. 04:06:42
@infinisil:matrix.orginfinisil danielsidhion: html for nixos is needed so users can read the docs without needing an internet connection 04:08:07
@jade_:matrix.org@jade_:matrix.org yeah i would suggest looking into optimizing nrd also? 04:08:18
@jade_:matrix.org@jade_:matrix.org it feels like we are throwing several babies out with the bathwater here 04:08:35
@danielsidhion:nixos.devdanielsidhionDepending on what we find (and this will mostly only matter after we finish looking at the options we have on our list), we might need a specific tool for manpage building anyway, and if that tool can do fast html for in-your-os, then that would be cool too04:08:50
@infinisil:matrix.orginfinisilAlso nixos-render-docs is like really fast already.. a couple seconds04:09:09
@infinisil:matrix.orginfinisil * Also nixos-render-docs is like really fast already.. a couple seconds!04:09:11
@danielsidhion:nixos.devdanielsidhionA bunch of options we found that we're looking into say that they build manpages as well with plugins, but how good those things are is yet to be determined04:09:45

Show newer messages


Back to Room ListRoom Version: 6