!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem94 Servers

Load older messages


SenderMessageTime
5 Jun 2023
@asymmetric:matrix.dapp.org.ukasymmetric infinisil: any idea why i got another couple of updated calendar event emails? 14:39:58
@asymmetric:matrix.dapp.org.ukasymmetricfor the team meetings14:40:02
@asymmetric:matrix.dapp.org.ukasymmetricit's not clear from the emails what has been updated14:40:13
@asymmetric:matrix.dapp.org.ukasymmetric * infinisil: any idea why i got another pair of updated calendar event emails? 14:42:01
@asymmetric:matrix.dapp.org.ukasymmetric * infinisil: any idea why i got another pair of calendar emails about updated events? 14:42:14
@fricklerhandwerk:matrix.orgfricklerhandwerk proofconstruction: here's the overview of the Nix ecosystem workshop participants created recently 15:11:36
@fricklerhandwerk:matrix.orgfricklerhandwerkNix Developer Workshop – Architecture Diagram.svg
Download Nix Developer Workshop – Architecture Diagram.svg
15:11:43
@proofconstruction:matrix.orgproofconstructionThanks!15:14:26
@proofconstruction:matrix.orgproofconstruction Is there any similar diagram for how the documentation is structured? 15:14:59
@proofconstruction:matrix.orgproofconstruction Or intended to be structured, maybe 15:15:10
@proofconstruction:matrix.orgproofconstructionI have an action item to begin one, if not15:38:10
@fricklerhandwerk:matrix.orgfricklerhandwerkThere is no diagram. Essentially, every component has some sort of reference documentation somewhere. We’re working on setting up nix.dev to provide guidance on how to use the “official platform” tools, i.e. with the other Diataxis categories. The manuals are linked from the top level navigation.15:38:44
@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

Show newer messages


Back to Room ListRoom Version: 6