!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

446 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
5 Jun 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkWe may want to provide visual representation of the ecosystem architecture early on, but each component’s internal architecture should be left to be presented on its own terms. But I don’t think it’s a priority.15:45:51
6 Jun 2023
@tek:tryp.io@tek:tryp.io joined the room.10:37:31
@sternenseemann:systemli.orgsterni it occurs to me that neither the manual nor CONTRIBUTING.md mention a clear policy for what manual-related commit messages should look like. I think there's a convention to have path-like prefixes like nixos/doc or doc, but maybe we should codify that. 10:40:47
@fricklerhandwerk:matrix.orgfricklerhandwerkSure, go ahead and make a proposal. I think it can be fairly lightweight. Git tracks files changed, labels get added accordingly, and usually all one needs to judge what's going on at a glance is some keyword in the change statement, such as "document X" or "mention Y in the manual"11:28:15
@fricklerhandwerk:matrix.orgfricklerhandwerk * Sure, go ahead and make a proposal, I'll be happy to pick it up for review. :) I think it can be fairly lightweight. Git tracks files changed, labels get added accordingly, and usually all one needs to judge what's going on at a glance is some keyword in the change statement, such as "document X" or "mention Y in the manual"11:28:58
@infinisil:matrix.orginfinisilJust a note that I will take some time off soon, from Thursday 22 June to Friday 7 July. I don't plan to be in the docs team meetings throughout that time, but I do expect to be somewhat active on GitHub and Matrix 😃11:49:21
@vcunat:matrix.orgvcunat changed their display name from Vladimír Čunát to @vcunat.17:21:15
8 Jun 2023
@asymmetric:matrix.dapp.org.ukasymmetrichttps://guix.gnu.org/blog/2023/from-development-environments-to-continuous-integrationthe-ultimate-guide-to-software-development-with-guix/12:36:33
@kranzes:matrix.org@kranzes:matrix.orgDoes scheme basically has no syntax but parentheses lol13:55:56
@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

Show newer messages


Back to Room ListRoom Version: 6