| 2 Nov 2024 |
|  isabel changed their profile picture. | 10:07:46 |
| 4 Nov 2024 |
 Minijackson | Hey all! I've been developing sphinxcontrib-nixdomain these past months,
which is a project for documenting Nix "objects" in the Sphinx documentation system.
Currently it only support NixOS options, but I plan on adding support for packages and libs.
It's currently missing some documentation (heh) and it's not currently published on PyPi,
but I think it'd be quite a useful project for non-nixpkgs Nix projects.
Here's an example of what it looks like in a real project: https://epics-extensions.github.io/EPNix/nixos-services/options-reference/archiver-appliance.html
Is this something you'd be interested in?
I think I'll be needing help for example to fetch doc comments like nixdoc does.
| 12:46:32 |
 fricklerhandwerk | Nice, this looks really good. Would definitely be great for nix.dev where we could integrate it right away. | 13:37:47 |
| Minijackson | I should work on getting it published and inside nixpkgs, then. Should the project be in nix-community? | 13:46:15 |
| Minijackson | Note that right now, the project is only useful for project that define their own NixOS option. I'd like to make a Sphinx role for referring to options defined in nixpkgs, but it's not implemented right now | 13:54:19 |
| fricklerhandwerk | We can already try without any of that and see how it goes, no need to block. Could you open a PR to use it on some page? Eg the first section of the module system tutorial and render the example module | 13:54:50 |
| Minijackson | In reply to @fricklerhandwerk:matrix.org
We can already try without any of that and see how it goes, no need to block. Could you open a PR to use it on some page? Eg the first section of the module system tutorial and render the example module I'll look into it! | 13:55:15 |
| Minijackson | this page then: https://nix.dev/tutorials/module-system/a-basic-module/ ? | 13:56:39 |
| Minijackson | or the deep dive? | 13:56:42 |
| fricklerhandwerk | In reply to @Minijackson:matrix.org
Note that right now, the project is only useful for project that define their own NixOS option. I'd like to make a Sphinx role for referring to options defined in nixpkgs, but it's not implemented right now If it works via optionsDoc and one can pass a config it should be easy to just hand it anything, including NixOS stuff, right? | 13:56:51 |
| Minijackson | In reply to @fricklerhandwerk:matrix.org
If it works via optionsDoc and one can pass a config it should be easy to just hand it anything, including NixOS stuff, right? yup | 13:57:14 |
| fricklerhandwerk | In reply to @Minijackson:matrix.org
this page then: https://nix.dev/tutorials/module-system/a-basic-module/ ? Yeah that would work. Anything you like and is a quick win | 13:57:17 |
| 5 Nov 2024 |
 asymmetric | hey, just noticed that some of the links in this page are actually anchors to this article, i.e. they shouldn't be there | 11:48:49 |
| asymmetric | * hey, just noticed that some of the links on this page are actually anchors to this article, i.e. they shouldn't be there | 11:49:05 |
| asymmetric | e.g. "Prerequisites" | 11:49:26 |
| 6 Nov 2024 |
 getpsyched | Hi, @Soenke Klinger. Is it cool if we continue our release notes conversation here? The 24.11 release is almost here and if we want have additions, now would be a good time :) | 09:21:59 |
 soenke | @getpsyched:matrix.org: thought about contacting,you. Its good, meybe we need,two discussions. Here about the Documentation ecosytem and manuals. And in the wiki channel about the wiki content? | 13:09:38 |
| getpsyched | Absolutely. | 13:11:46 |
| getpsyched | I'll get getchoo to join, so we can get things moving quickly | 13:13:53 |
|  seapat joined the room. | 13:50:48 |
 dish [Fox/It/She] | whoa getchoo reference 🤯 | 15:21:16 |
 Soenke Klinger | fricklerhandwerk: Could you coordinate the discussion about documentation release notes here with getpsyched? | 18:44:49 |
| fricklerhandwerk | In reply to @soenkeklinger:matrix.org
fricklerhandwerk: Could you coordinate the discussion about documentation release notes here with getpsyched? Sure, what exactly is it about? | 18:45:46 |
| Soenke Klinger | NixOS 24.11 release notes. Its a good idea to describe what happened regarding documentation. (In wiki channel, we write about the wiki part). Release notes are a good place include some relevant information about the ecosystem and not only about package-version-upgrades.. | 18:48:32 |
| getpsyched | Let's get on the same page about a few non-variables (mostly reiterating from the conversation we had),
These release notes will be in the highlights section 2-3 sentences per release note (and how many of those?)
Same goes for the other documentation (non-wiki) release notes | 18:53:31 |
| getpsyched | As discussed, we won't keep a criteria for the content itself, and that can be decided internally by both teams | 18:54:21 |
| getpsyched | Let's get on the same page about a few non-variables (mostly reiterating from the conversation we had),
These release notes will be in the highlights section 2-3 sentences per release note (and how many of those?)
Same goes for the wiki's release notes | 18:56:54 |
|  getchoo joined the room. | 21:26:55 |
| getchoo | In reply to @pyrox:pyrox.dev
whoa getchoo reference 🤯 😄 | 21:27:16 |
| dish [Fox/It/She] | In reply to @getchoo:matrix.org
😄 👁️ | 21:40:36 |
