Nix Documentation | 422 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 86 Servers |
| Sender | Message | Time |
|---|---|---|
| 2 Jan 2024 | ||
In reply to @asymmetric:matrix.dapp.org.ukThis just where it’s hosted. I read your question as “which content should be part of the nix.dev source” | 15:56:55 | |
| yeah good point | 15:57:44 | |
| 3 Jan 2024 | ||
| imo: our module system docs are faulty, in that you can't write guide level stuff in them | 12:49:01 | |
| which is a symptom of "services.jellyfin" or whatever not being a distinct entity in the module system and thus you can't attach docs to it | 12:49:29 | |
| it would be sick if we could attach docs to such things | 12:49:42 | |
| Oh that would be fantastic | 12:54:06 | |
| Same for changelogs in practice | 14:03:11 | |
| 15:33:23 | ||
| i'm going to try to join the the nix documentation meeting tomorrow; can someone acknowledge that they see this message | 19:49:52 | |
| ty! | 20:06:39 | |
| I'll join the meeting as well. I could need some help with migration of the nixpkgs manual rendering. (nixos-render-docs) I'd like to discuss the future of that tooling after rfc145 was merged. Who has the ownership about this? @pennae or fricklerhandwerk ? | 20:52:25 | |
| * I'll join the meeting as well. I could need some help with migration of the nixpkgs manual rendering. (nixos-render-docs) I'd like to discuss the future of that tooling after rfc145 was merged. Who has the ownership about this? @pennae or fricklerhandwerk ? | 20:52:39 | |
In reply to @johannes.kirschbauer:scs.ems.host@pennae wrote all of it, I have only cursory knowledge of that code | 23:44:11 | |
| Also I won’t be able to participate in meetings in the next two months or so | 23:44:53 | |
| 4 Jan 2024 | ||
| Johannes Kirschbauer @hsjobeki: I'll be there in the meeting, we could also take a look at the nixdoc PR | 01:39:44 | |
| infinisil: PR to document the conventions as discussed in the meeting: https://github.com/NixOS/nixpkgs/pull/278762 I've been adding this documentation-reviewers team on my PRs because it seems more appropriate than adding the documentation team. Is this appropriate, or should I just stick to adding the documentation team instead? | 20:05:59 | |
| danielsidhion: No that's perfect :) | 20:06:38 | |
| Also as discussed in the meeting, here's a quick overview of what I'm doing: for no reason at all, I decided it would be a good idea to go through the Nixpkgs manual source and update all examples to the admonition syntax as specified in the doc readme. As I did this, I realised that other things could also be updated to follow a more consistent style, and I also started finding a lot of outdated content in the manual, which I'm making an effort to also update. More than one person has asked how they could help, so I created a tracking issue here: https://github.com/NixOS/nixpkgs/issues/278769 | 20:34:17 | |
| Chris McDonough: check the message above. I'm also creating some more issues on the nixpkgs repo for things I find as I read the manual. Those are either for extra documentation, or things in nixpkgs itself. I'd rather not paste a bunch of links here, but you can check issues I opened in the nixpkgs repo (I'm @danielsidhion there too) | 20:36:24 | |
| danielsidhion: Very nice! | 21:05:55 | |
| 5 Jan 2024 | ||
In reply to @danielsidhion:nixos.devI wonder if we could get an LLM do tackle these refactors? It seems pretty algorithmic, and like it should work, but I have no experience with them so I don’t really know | 10:07:39 | |
In reply to @danielsidhion:nixos.dev* I wonder if we could get an LLM to tackle these refactors? It seems pretty algorithmic, and like it should work, but I have no experience with them so I don’t really know | 10:07:55 | |
| The algorithmic part of this effort is too small compared to the human effort still required. I'm also reading and updating the content (biggest effort, since it requires research in most cases, but I consider it outside the scope of the work, I just can't help trying to make things better), making sure the code in the examples can be run (sometimes I have to go find something from nixpkgs instead of going with the generic stuff in some examples), and looking for other things that could be adopted as a convention to bring more consistency to the manual | 11:16:43 | |
| The dockerTools section is very long, so I'm going to create PRs for each subsection. I won't attend the meeting on Monday, but I'd appreciate if you folks could review https://github.com/NixOS/nixpkgs/pull/278956 if you have the time to do it there! | 16:58:46 | |
| 21:01:27 | ||
| 21:01:49 | ||
| 6 Jan 2024 | ||
| 18:07:55 | ||
| 9 Jan 2024 | ||
| 08:38:33 | ||
| Regarding this issue, in the event the documentation team were to receive some funds, I wonder how prepared we would be, in terms of distributing funds, both to people and to tasks. fricklerhandwerk you probably have experience here? Is there some document that it would make sense to take a look at before this call? | 09:19:19 | |
In reply to @asymmetric:matrix.dapp.org.ukAs always when getting money, there needs to be some setting goals and coordination. There is also Google Season of Docs coming up again, and preparing a project for applying would be good. We have some preliminary work back from the STF application in June that could be built upon. | 11:39:55 | |