!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

421 Members
Discussion about documentation improvements around the Nix ecosystem83 Servers

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


SenderMessageTime
5 Oct 2023
@alejandrosame:matrix.orgalejandrosameI won't be joining today. I'll be in transit at the time of the meeting.13:21:28
6 Oct 2023
@olafklingt:matrix.org@olafklingt:matrix.orgwhat prevents this pr from being reviewed or merged? https://github.com/NixOS/nix.dev/pull/72513:24:26
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @olafklingt:matrix.org
what prevents this pr from being reviewed or merged? https://github.com/NixOS/nix.dev/pull/725
It’s in my queue that’s way too long. Sorry for the unbounded delay. I’ll take care of it later today.
16:05:54
9 Oct 2023
@b:chreekat.netchreekat changed their display name from chreekat to chreekat (afk, admin day).10:19:11
@i97henka:matrix.orghenrik-chsorry, no doc meeting for me today - have a good session!13:32:11
@kidsan:matrix.orgkidsan joined the room.14:02:14
@mightyiam:matrix.org@mightyiam:matrix.orgUpdate from me: working in some capacity on releasing a doctester.14:15:00
@zhenbo:matrix.orgzhenbo joined the room.21:55:51
10 Oct 2023
@niahex:matrix.orgNia joined the room.05:16:03
@b:chreekat.netchreekat changed their display name from chreekat (afk, admin day) to chreekat.11:39:20
@alejandrosame:matrix.orgalejandrosame Today I managed to work on \https://github.com/NixOS/nix.dev/pull/515 19:42:41
@alejandrosame:matrix.orgalejandrosame * Today I managed to work on https://github.com/NixOS/nix.dev/pull/51519:42:46
11 Oct 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk

https://github.com/stepchowfun/tagref

This is an interesting idea. Never mind the particular implementation. It seems like one could hack together some simple pre- or post-processing to allow for linking to code locations across source type boundaries in rendered documentation.

04:04:35
@asymmetric:matrix.dapp.org.ukasymmetric note that an alternative approach is literate programming, e.g. org-mode + babel. in org-mode you can easily link to other notes (or specific sections of notes). 10:48:18
@asymmetric:matrix.dapp.org.ukasymmetric

is anyone actively working on documenting the module system? I know about existing efforts, and i vaguely remember proofconstruction working on this, but what's the current status?

i'd be interested in taking on some of this work.

10:49:25
@teoc:matrix.orgTeo (he/him) changed their display name from Teo (he/they) to teo (they/he).15:54:50
12 Oct 2023
@proofconstruction:matrix.orgproofconstruction
In reply to @asymmetric:matrix.dapp.org.uk

is anyone actively working on documenting the module system? I know about existing efforts, and i vaguely remember proofconstruction working on this, but what's the current status?

i'd be interested in taking on some of this work.

infinisil dumped notes and git commits https://github.com/NixOS/nix.dev/pull/645 from a previous summer of nix presentation, which i've massaged into something tutorial-like https://github.com/NixOS/nix.dev/pull/730. i've just completed a big move and started a new gig, so very scattered (more than usual for me!) currently, but somewhere i have notes towards a much shorter introduction (silvan's presentation became like 1200 lines of tutorial, way too big for a single page)
04:07:21
@b:chreekat.netchreekat changed their display name from chreekat to chreekat (afk, sick).08:03:25
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk

is anyone actively working on documenting the module system? I know about existing efforts, and i vaguely remember proofconstruction working on this, but what's the current status?

i'd be interested in taking on some of this work.

There are 1-2 open PRs to the Nixpkgs manual by Robert Hensing (roberth)
08:20:23
@asymmetric:matrix.dapp.org.ukasymmetric Yep, I think I know of them thanks to your post which gathers them all. I was more asking if there’s any concerted effort to get this all merged. If not I’d like to take this on, and could of course use some help from people who have put effort in it so far 09:10:31
@asymmetric:matrix.dapp.org.ukasymmetric* Yep, I think I know of them thanks to your post which gathers them all. I was more asking if there’s any concerted effort to get this all organized, improved and merged. If not I’d like to take this on, and could of course use some help from people who have put effort in it so far09:41:31
@alejandrosame:matrix.orgalejandrosameRedacted or Malformed Event10:34:26
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostI want to share my POC with the documentation team: https://hsjobeki.github.io/nix-doc-comments/reference/lib/debug/lib-debug-runtests/ Fully automated reference manual for the whole api surface of nix. In my vision this could replace: https://nix.dev/reference If you are interested into implementation details; it requires the rfc-145 and migrated-comments (according to the rfc) in nixpkgs.10:47:14
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * I want to share my POC with the documentation team: https://hsjobeki.github.io/nix-doc-comments/reference/lib/debug/lib-debug-runtests/ Fully automated reference manual for the whole api surface of nix. In my vision this could replace: https://nix.dev/reference If you are interested into implementation details; it requires the rfc-145 and migrated-comments (according to the rfc) in nixpkgs. (This is still a POC) 10:48:47
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * I want to share my POC with the documentation team: https://hsjobeki.github.io/nix-doc-comments/reference/lib/debug/lib-debug-runtests/ Fully automated reference manual for the whole api surface of nix. In my vision this could replace: https://nix.dev/reference If you are interested into implementation details; it requires the rfc-145 and migrated-comments (according to the rfc) in nixpkgs. (This is still a POC so expect bugs and beeing incomplete) 10:55:05
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Yep, I think I know of them thanks to your post which gathers them all. I was more asking if there’s any concerted effort to get this all organized, improved and merged. If not I’d like to take this on, and could of course use some help from people who have put effort in it so far
No one currently working on it actively. Would be awesome if you could take that on.
12:44:28

Show newer messages


Back to Room ListRoom Version: 6