!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

439 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
8 Jun 2023
@kranzes:matrix.org@kranzes:matrix.orgSo ugly 13:56:19
@kranzes:matrix.org@kranzes:matrix.orgAnd confusing really 13:56:31
@kranzes:matrix.org@kranzes:matrix.orgIt's just so nested too13:57:02
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pw joined the room.16:12:43
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pw

I wrote about devenv stacks recently: https://blog.testdouble.com/posts/2023-05-02-frictionless-developer-environments/

I am pretty stoked about the documentation project that is going on

16:15:09
9 Jun 2023
@pennae:matrix.eno.spacepennaewe've pulled our nixpkgs-with-nrd branch out again and have so far managed to reduce the html manual diff to 7000 lines. still incomplete, but progress19:46:29
@pennae:matrix.eno.spacepennaemost of the diff now seems to stem from lib function docs using markdown where that was previously very not supported19:48:01
@pennae:matrix.eno.spacepennaemissing features in nrd discovered: tables, footnotes, images20:44:33
@pennae:matrix.eno.spacepennae all the manuals of nixpkgs and nixos combined contain one image, and it's a dot graph of the staging workflow 20:44:58
@jtojnar:matrix.orgJan Tojnar and even better, the conversion of the diagram to svg is done by a [pandoc lua filter]https://github.com/NixOS/nixpkgs/blob/b6088ea2f32335978f366708440b0f4ded5b7f9f/doc/Makefile#L12) 20:52:22
@jtojnar:matrix.orgJan Tojnar * and even better, the conversion of the diagram to svg is done by a pandoc lua filter 20:52:33
@jtojnar:matrix.orgJan Tojnar * and even better, the conversion of the diagram to svg is done by a pandoc lua filter 20:53:06
@pennae:matrix.eno.spacepennae yeah, we've known about that particular image for a while
we'll just extract it, render it to svg, and that's that
20:55:43
10 Jun 2023
@pennae:matrix.eno.spacepennaepandoc does not seem to natively support rendering docbook figures from image sources? excellent.15:12:07
@pennae:matrix.eno.spacepennae

i think before we really migrate the nixos manual away from docbook we'll have to

a. drop epub (temporarily)
b. drop docbook support from nixos-render-docs

otherwise it'll just be too complicated to keep everything sufficiently in sync as time goes on

19:37:18
@pennae:matrix.eno.spacepennaeadding epub export to nrd is always an option, but docbook has to go :/19:47:19
11 Jun 2023
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwWhere is the current manual located?00:53:28
@pennae:matrix.eno.spacepennaewhich one? rendered or source?00:54:36
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwSource! I’m curious about the above changes to your workflow and current state-of-the-world01:35:54
@pennae:matrix.eno.spacepennaenixpkgs and nixos manuals live in the nixpkgs repo, under doc and nixos/doc respectively01:37:02
@pennae:matrix.eno.spacepennaestate of the world is basically "ugh"01:38:37
@pennae:matrix.eno.spacepennaethere's a lot of legacy docbook workflow that's in an eternal state of being replaced but not quite gone yet, which is always very fun and makes docs build errors extremely Fun™ to debug01:40:44
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwIs it just built with CI? Much like a Unix system, I know CI.01:42:22
@pennae:matrix.eno.spacepennaeci does build docs for prs, docs for user systems are built by hydra but use the same expressions01:43:33
@pennae:matrix.eno.spacepennaeor, if users added to the docs (eg via the module system), the docs are built on the user system. that's probably not the common case though01:44:28
@pennae:matrix.eno.spacepennaeespecially since the nixos docs build was excrutiatingly slow for the longest time and still spends way to much time in docbook even now, but that's on the way out at least01:45:10
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwOkay. Well, my current project at work is called “CI Speed”. Where are the jobs stored? I can piece together what they do and maybe find a quicker way to build it.01:50:23
@pennae:matrix.eno.spacepennaewe've got the speed thing sorted out, it's just a question of removing the docbook interim stage01:52:55
@pennae:matrix.eno.spacepennaewhich is also for the most part just needs flipping a switch (and emplacing some dummy epubs that link to the html manual)01:53:56
@pennae:matrix.eno.spacepennae(i think last we benchmarked it the docbook-free nixos manual build took five seconds, vs five minutes it took a few releases ago before xsltproc got their shit together somewhat)01:55:33

Show newer messages


Back to Room ListRoom Version: 6