| 9 Oct 2023 |
|  zhenbo joined the room. | 21:55:51 |
| 10 Oct 2023 |
|  Nia joined the room. | 05:16:03 |
|  chreekat changed their display name from chreekat (afk, admin day) to chreekat. | 11:39:20 |
 alejandrosame | Today I managed to work on \https://github.com/NixOS/nix.dev/pull/515 | 19:42:41 |
| alejandrosame | * Today I managed to work on https://github.com/NixOS/nix.dev/pull/515 | 19:42:46 |
| 11 Oct 2023 |
 fricklerhandwerk | 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 | 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 | 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 |
|  Teo (he/him) changed their display name from Teo (he/they) to teo (they/he). | 15:54:50 |
| 12 Oct 2023 |
 proofconstruction | 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 |
| chreekat changed their display name from chreekat to chreekat (afk, sick). | 08:03:25 |
| fricklerhandwerk | 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 | 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 | * 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 | 09:41:31 |
| alejandrosame | Redacted or Malformed Event | 10:34:26 |
 @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. | 10:47:14 |
| @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 | * 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 | 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 |
| fricklerhandwerk | In reply to @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)
This looks great. Still, as @roberth suggested elsewhere recently, we should not encourage using builtins to keep separation of concerns. I suggest rendering what you have to the Nixpkgs manual. It would also avoid getting into hairy consistency problems between Nix and Nixpkgs documentation. The nix.dev reference section should ideally consist only of links to the manuals, but some things are currently hard to do in an ideal way. | 12:51:08 |
 Robert Hensing (roberth) | In reply to @fricklerhandwerk:matrix.org
There are 1-2 open PRs to the Nixpkgs manual by Robert Hensing (roberth) I can do a round of review processing. Yoloing my schedule a bit | 12:52:51 |
| Robert Hensing (roberth) | as in right now | 12:53:21 |
| alejandrosame | I won't be able to join today. Let me know if I need to something else regarding PR 515 | 13:10:24 |
| fricklerhandwerk | Me neither, sorry for the short notice | 13:28:25 |
| alejandrosame | * I won't be able to join today. Let me know if I need to do something else regarding PR 515 | 13:52:45 |
 davidak | FYI: MEME about NixOS docs 😬
https://mstdn.social/@runarcn/111215892873933877 | 16:46:09 |
 @adam:robins.wtf | oof | 18:18:34 |
| 13 Oct 2023 |
 Lorenz Leutgeb | FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format :[<n>:]<path>.
See:
- [Git Glossary](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftree-ishatree-ishalsotreeish
- Git Revisions
| 14:49:15 |
| Lorenz Leutgeb | * FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format :[<n>:]<path>.
See:
- [Git Glossary](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftree-ishatree-ishalsotreeish)
- Git Revisions
| 14:49:21 |
| Lorenz Leutgeb | * FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format :[<n>:]<path>.
See:
| 14:49:30 |
