!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

421 Members
Discussion about documentation improvements around the Nix ecosystem85 Servers

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


SenderMessageTime
8 Mar 2024
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @pennae:matrix.eno.space
do you really want to bind up another few years worth of work after the first migration hasn't even been shipping for six months
As said, i feel like any potential migration needs to go through an RFC, to make sure all important aspects from the community taken into account
10:19:08
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @danielsidhion:nixos.dev
I'd appreciate any links or resources you can send me that show things that we'll need to solve in the other docs frameworks as well. I have a list of things already, but idk how complete it is
there's no full list as such in a single place, sadly. but whatever you'd choose would have to do manpage generation that isn't hot garbage (like the nix manpages), be able to run often and quickly (because docs is part of a nixos system build), support all the syntax extensions we have somehow (or rewrite a bunch of the docs), somehow be able to generate the option man/html pages, there's of course the issue of how to handle nixos module documentation chapter (which are distinct from option docs), the different formats of export for downstream consumers. there's more, those are just the few that immediately come to mind
10:21:31
@danielsidhion:nixos.devdanielsidhionWhat do you mean by manpage generation? Are you referring to https://github.com/NixOS/nixpkgs/blob/master/doc/manpage-urls.json ?10:22:27
@danielsidhion:nixos.devdanielsidhionI didn't have performance on the list, but I'll add it as well10:23:06
@infinisil:matrix.orginfinisil danielsidhion: I think man configuration.nix is meant 10:23:47
@infinisil:matrix.orginfinisilI don't think anything else is rendered with man pages10:24:17
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @infinisil:matrix.org
I don't think anything else is rendered with man pages
yes, that was explicitly decided against because generating good manpages and html pages from the same source is damn near impossible
10:24:44
@pennae:matrix.eno.space@pennae:matrix.eno.spacethat's why the other nixos manpages are written the old-fashioned way10:25:05
@infinisil:matrix.orginfinisil danielsidhion: Can you publish that list somewhere? 10:27:00
@infinisil:matrix.orginfinisilI guess just on https://pad.lassul.us/ would work10:27:11
@danielsidhion:nixos.devdanielsidhion
In reply to @infinisil:matrix.org
danielsidhion: Can you publish that list somewhere?
Just quickly copy-pasted from another note I'm keeping, some of the things may not be very descriptive https://pad.lassul.us/TqtuSR-GReyIXHGISZ-S1Q?view
10:30:02
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostWe could still let nrd do manpage rendering tbh. thats something nrd does really well. But i'd favor to migrate the web html stuff specifically. However that could work, we'd need to figure out if we really want to do it.10:32:47
@pennae:matrix.eno.space@pennae:matrix.eno.space yes. figure out your needs that aren't met first
(and then you'll probably find that most of them are not hard to add to the tooling that's already in place)
10:34:20
@fricklerhandwerk:matrix.orgfricklerhandwerk Johannes Kirschbauer @hsjobeki: so far all you seem to be lamenting is the web skin. But that’s the cheap part. No off-the-shelf framework will do the domain-specific heavy lifting with an order of magnitude less custom code. 10:51:33

Show newer messages


Back to Room ListRoom Version: 6