Nix Documentation | 435 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 91 Servers |
| Sender | Message | Time |
|---|---|---|
| 11 Oct 2023 | ||
| 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 | |
| 15:54:50 | ||
| 12 Oct 2023 | ||
In reply to @asymmetric:matrix.dapp.org.ukinfinisil 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 | |
| 08:03:25 | ||
In reply to @asymmetric:matrix.dapp.org.ukThere are 1-2 open PRs to the Nixpkgs manual by Robert Hensing (roberth) | 08:20:23 | |
| 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 | |
| * 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 | |
| Redacted or Malformed Event | 10:34:26 | |
| 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 | |
| * 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 | |
| * 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 | |
In reply to @asymmetric:matrix.dapp.org.ukNo one currently working on it actively. Would be awesome if you could take that on. | 12:44:28 | |
In reply to @johannes.kirschbauer:scs.ems.hostThis 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 | |
In reply to @fricklerhandwerk:matrix.orgI can do a round of review processing. Yoloing my schedule a bit | 12:52:51 | |
| as in right now | 12:53:21 | |
| I won't be able to join today. Let me know if I need to something else regarding PR 515 | 13:10:24 | |
| Me neither, sorry for the short notice | 13:28:25 | |
| * I won't be able to join today. Let me know if I need to do something else regarding PR 515 | 13:52:45 | |
| FYI: MEME about NixOS docs 😬 https://mstdn.social/@runarcn/111215892873933877 | 16:46:09 | |
| oof | 18:18:34 | |
| 13 Oct 2023 | ||
| FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format See:
| 14:49:15 | |
| * FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format See:
| 14:49:21 | |
| * FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format See: | 14:49:30 | |
| * FWIW, what I don't like about this format is that it is incompatible with Git's tree-ish format See: | 19:24:16 | |
| 14 Oct 2023 | ||
| 08:54:15 | ||
| i've been mentioned directly here, not sure why, but anyway: as the docs team, do we have anything to say in this regard? Or can I go ahead and say "No blockers from the doc team"? I think it's a no-brainer but wanted to check with someone else first | 12:46:54 | |
| oh i see why: https://github.com/NixOS/nixpkgs/tree/1af277b55ed1fd600bc917233c83c51d06e14b8f/maintainers/team-list.nix#L252 | 12:50:06 | |
| two questions:
| 12:51:16 | |
ok 2. makes sense after reading this, although it seems to me it should default to true | 13:26:04 | |
| 15 Oct 2023 | ||
| Hi all, here I am back asking for help. :) | 07:41:06 | |