!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

420 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
16 Mar 2024
@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
@jade_:matrix.org@jade_:matrix.org i still can't understand why everyone's immediate thought is constantly to replace nrd other than for lack of desire to look at the code and how it can achieve the goals set out  04:09:52
@danielsidhion:nixos.devdanielsidhionI agree with the other arguments though - python is more approachable than c04:10:07
@jade_:matrix.org@jade_:matrix.org (for what it's worth i would be very suspicious of any man page generation plugin) 04:10:08
* @infinisil:matrix.orginfinisil agrees with giving nrd a fairer try. Having looked at the code base, it seems very approachable04:10:46
@jade_:matrix.org@jade_:matrix.org (generally man page generators (especially if they are bolted on the side of something else) are very very much trying to fit something that's not a man page into the shape of a man page and not considering the range of semantic expressiveness of the format) 04:11:26
@danielsidhion:nixos.devdanielsidhion
In reply to @jade_:matrix.org
i still can't understand why everyone's immediate thought is constantly to replace nrd other than for lack of desire to look at the code and how it can achieve the goals set out 
I've looked at the code already, and the effort to get it to where I'd like it to be is not insignificant
04:11:42
@danielsidhion:nixos.devdanielsidhionWhich is why I'm looking at other options too04:11:55
@rina/:matrix.orgkaitnow for my main motivation for joining: what happened to the main manual? is there any announcement or documentation regarding the changes?04:25:16
@infinisil:matrix.orginfinisil kait/: Oh you mean because it looks different now? 04:25:43
@rina/:matrix.orgkaitit does!04:25:50
@infinisil:matrix.orginfinisil kait/: That's a regression caused by the marketing team, see https://github.com/NixOS/nixos-homepage/issues/1251, unfortunately it was ignored.. 04:27:04
@infinisil:matrix.orginfinisil danielsidhion here is the hero stepping in with a fix in https://github.com/NixOS/nixpkgs/pull/295847 🚀 04:28:09
@rina/:matrix.orgkaitoh gosh!04:28:51
@rina/:matrix.orgkaitso it is not permanent (relieved 😌)04:29:14
@danielsidhion:nixos.devdanielsidhion(that PR is just waiting for approvals or more requests for changes btw!)04:29:23
@infinisil:matrix.orginfinisil kait/: Good rule in Nix in general: Things can be shitty for arbitrarily long, untli somebody decides to improve them 04:30:53
@infinisil:matrix.orginfinisil And arbitrary long can be really long, like decades lol 04:31:19
@rina/:matrix.orgkaiti am starting to see that. though, i do not mind pitching in where i can :)04:31:55
@danielsidhion:nixos.devdanielsidhion That PR won't get the manuals to exactly like they were before, but I'd say it gets ~95% of the way there, which is enough to give us time to resume improving the content and keep researching options to find where we want to be in the long term 04:32:50
@ryantm:matrix.orgryantmThe need for a fast and very low dependency tool for building the NixOS manual during builds was the original motivation behind mmdoc.04:40:21
@infinisil:matrix.orginfinisil ryantm: Can you compare the numbers between nrd and mmdoc? 04:41:28
@infinisil:matrix.orginfinisilI don't think nrd is heavy on dependencies, and it seems really fast too04:41:52
@ryantm:matrix.orgryantmDoes someone have nrd building NixOS or Nixpkgs?04:42:24
@ryantm:matrix.orgryantmNixOS or Nixpkgs manuals*04:43:10

Show newer messages


Back to Room ListRoom Version: 6