Nix Documentation | 420 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 86 Servers |
| Sender | Message | Time |
|---|---|---|
| 10 Mar 2025 | ||
| 15:29:10 | ||
| Hello, just wanted to ping the docs team about this project I've recently made: https://discourse.nixos.org/t/announcing-easy-nix-documentation/61434 | 15:30:10 | |
In reply to @ayatsfer:matrix.orgThanks, appreciated! Feel free to discuss further ideas here, love to hear your thoughts on where you want to take it | 17:25:25 | |
| 22:30:07 | ||
| 11 Mar 2025 | ||
| fricklerhandwerk: for now it's just ~300 lines of JS boilerplate that I wanted to factor out of my module system projects | 08:03:44 | |
| so if other people wanting to document their modules use it, then great. But if I'm the only user then it's fine too | 08:04:47 | |
I would like to write doc comments for Emacs lisp build helpers. I can get them in repl using :doc now. Do do I have them rendered in the nixpkgs manual? | 11:54:49 | |
* I would like to write doc comments for Emacs lisp build helpers. I can get them in repl using :doc now. Do do I have those doc comment rendered in the nixpkgs manual? | 11:55:33 | |
* I would like to write doc comments for Emacs lisp build helpers. I can get them in repl using :doc now. Do do I have those doc comments rendered in the nixpkgs manual? | 11:55:48 | |
* I would like to write doc comments for Emacs lisp build helpers. I can get them in repl using :doc now. How do I have those doc comments rendered in the nixpkgs manual? | 11:59:34 | |
In reply to @me:linj.techI don’t have it off the top of my mind, but roughly you need to add line in the table of contents for the section to be rendered. Please check any other section, grep the source for the anchor or file names, and see how it’s done | 13:02:22 | |
| 23:21:09 | ||
| 12 Mar 2025 | ||
| 21:09:09 | ||
| 15 Mar 2025 | ||
| 14:47:00 | ||
| 21:06:35 | ||
| 16 Mar 2025 | ||
| 15:12:17 | ||
| 17:40:03 | ||
| 18 Mar 2025 | ||
| 09:32:11 | ||
| Hello everyone, my name is MARYJANE an outreachy applicant for the june 2025 cohorts and i would like to contribute to this commnunity. | 09:48:14 | |
| Having read the documentation guide, i will like to be directed on how to begin my contribution | 09:49:13 | |
| Johannes Kirschbauer @hsjobeki: do you happen to have a good pointer for good-first-issues around Nixpkgs library documentation? Maybe something like reformatting to the new style along the lines of what danielsidhion was doing last year? | 22:03:24 | |
| 23:55:43 | ||
| So I'm factoring out a repeatedly used type into Does this need to be documented in | 23:59:06 | |
| (apologies if this room isn't about nixpkgs/nixos docs; I wasn't sure) | 23:59:33 | |
| 19 Mar 2025 | ||
In reply to @elvishjerricco:matrix.orgYes please, as long as that section is not auto-generated from doc comments | 07:34:34 | |
In reply to @elvishjerricco:matrix.orgThis room is about all documentation for official Nix projects! :) | 07:35:04 | |
| 07:35:54 | ||
In reply to @maryjane_:matrix.org Here’s a very basic thing: You could start out small and try to build the NixOS manual on your machine following the instructions. Those instructions have a leftover from when the mechanism was different and still say “you can quickly validate your edits with There are lots of such little inconsistencies, and carefully fixing any of them so the text doesn’t confuse readers is a valuable contribution! | 07:46:36 | |
fricklerhandwerk: thanks; added an entry to option-types.section.md | 07:51:18 | |
| Yeah the types.nix documentation is not not yet generated from source directly. Ndukauba Maryjane Oluchi That would be something. Its basically just moving things. | 10:17:17 | |