Nix Documentation | 404 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 78 Servers |
| Sender | Message | Time |
|---|---|---|
| 16 Mar 2025 | ||
| 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 | |
| Noted! thanks | 13:26:33 | |
| Alright. | 13:26:50 | |
| Ndukauba Maryjane Oluchi: if you open PRs, please ping me for reviews, otherwise I won’t notice them (Nixpkgs is huge and it’s impractical to subscribe to everything) | 15:55:29 | |
| Noted! fricklerhandwerk | 15:56:23 | |
| 16:17:25 | ||
| Hi fricklerhandwerk i am currently working on this issue. what do I Document in place of ' make ' ? | 19:02:37 | |
In reply to @maryjane_:matrix.orgIt’s in the example: you’d run the custom devmode command | 19:10:44 | |
| Okay so the instruction should say "You can quickly validate your edits with devmode command" ? | 19:15:02 | |
| 20 Mar 2025 | ||
| Hello everyone, I need some help. i am currently working on fixing the inconsistencies in the nixOs manual, just like fricklerhandwerk pointed out which i have done but now i am trying to confirm if the edits are visible already on the manual, but it isn't. what could be the issue? | 15:56:13 | |
| tried to build the manual locally using: /nix/store/dvm0rj35kfphj44rc4pn89cw9cs9bf3i-nixos-manual-html but my edits are not visible yet | 15:57:04 | |
| Just trying to confirm before i send in a PR | 16:20:56 | |
| Can you clarify what you mean by that? | 16:36:42 | |
| sure! let me give a breakdown on what i did . | 16:40:41 | |
| I used the Nix-shell environment to build the NixOs manually i edited these inconsistencies using the nano text editor, after doing that i tried to confirm if the edits i made has reflected in the nixOS manual before i send in a PR but it hasn't and that is why i am asking my question for clarification | 16:43:47 | |
| * I used the Nix-shell environment to build the NixOs manual locally i edited these inconsistencies using the nano text editor, after doing that i tried to confirm if the edits i made has reflected in the nixOS manual before i send in a PR but it hasn't and that is why i am asking my question for clarification | 16:44:20 | |
Have you run devmode and reviewed your changes in the live preview that opens after running the command? | 16:45:11 | |