!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

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


SenderMessageTime
8 Mar 2024
@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
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostI am not lamenting the skin. I am lamenting how web is done overall. It seems we are not expecting any heavy lifting on the web front are we? Its not going to be an easy or cheap task either, to find a way towards a state of the art web documentation because that is something users are expecting. 10:55:17
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
I am not lamenting the skin. I am lamenting how web is done overall. It seems we are not expecting any heavy lifting on the web front are we? Its not going to be an easy or cheap task either, to find a way towards a state of the art web documentation because that is something users are expecting.
Agreed, but let’s keep relative priorities in mind. I think a shiny surface (and that includes dynamic search) is one of the last of our problems. pennae‘s mention of regressions is important. Dropping in a different tool will break the hell out of existing links, and I agree that avoiding that has a chance of making things to take forever
11:01:39
@infinisil:matrix.orginfinisil Splitting the manuals into multiple pages is also important. That can apparently be done without much work using nixos-render-docs though as pennae told me 11:03:01
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostSo maybe we should start with those efforts. I also have a plan how to avoid breaking existing links.11:05:42
@infinisil:matrix.orginfinisilA really stupid way to avoid breaking links without javascript would be to replace the contents of each section with a link to the new link :P11:06:37

Show newer messages


Back to Room ListRoom Version: 6