!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

381 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
19 Mar 2025
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @elvishjerricco:matrix.org
(apologies if this room isn't about nixpkgs/nixos docs; I wasn't sure)
This room is about all documentation for official Nix projects! :)
07:35:04
@fricklerhandwerk:matrix.orgfricklerhandwerk changed the room topic to "This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest " from "This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation NixOS teams calendar: https://calendar.google.com/calendar/embed?src=b9o52fobqjak8oq8lfkhg3t0qg%40group.calendar.google.com Documentation office hours are open for anyone interested in solving problems, getting contributions reviewed in real time, or becoming a maintainer. Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest ".07:35:54
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @maryjane_:matrix.org
Hello everyone, my name is MARYJANE an outreachy applicant for the june 2025 cohorts and i would like to contribute to this commnunity.

Hi Ndukauba Maryjane Oluchi!

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 make”, but we’re not using makeany more. The example shows a shell prompt that doesn’t look like the actual thing: nix-shell$ instead of [nix-shell:~]$. In other places the formatting of parameter lists follows one format most of the time, but sometimes it’s different.

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
@elvishjerricco:matrix.org@elvishjerricco:matrix.org fricklerhandwerk: thanks; added an entry to option-types.section.md 07:51:18
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead

Yeah the types.nix documentation is not not yet generated from source directly.
We'd like to move the types and all other module system documentation out of the nixos manual, and put it into the reference documentation of nixpkgs instead.

Ndukauba Maryjane Oluchi That would be something. Its basically just moving things.

10:17:17
@maryjane_:matrix.orgMaryjaneNoted! thanks13:26:33
@maryjane_:matrix.orgMaryjaneAlright.13:26:50
@fricklerhandwerk:matrix.orgfricklerhandwerk 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
@maryjane_:matrix.orgMaryjane Noted! fricklerhandwerk 15:56:23
@jkxyz:matrix.org@jkxyz:matrix.org left the room.16:17:25
@maryjane_:matrix.orgMaryjane Hi fricklerhandwerk i am currently working on this issue.
what do I Document in place of ' make ' ?
19:02:37
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @maryjane_:matrix.org
Hi fricklerhandwerk i am currently working on this issue.
what do I Document in place of ' make ' ?
It’s in the example: you’d run the custom devmode command
19:10:44
@maryjane_:matrix.orgMaryjaneOkay so the instruction should say "You can quickly validate your edits with devmode command" ?19:15:02
20 Mar 2025
@maryjane_:matrix.orgMaryjane 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
@maryjane_:matrix.orgMaryjanetried to build the manual locally using: /nix/store/dvm0rj35kfphj44rc4pn89cw9cs9bf3i-nixos-manual-html but my edits are not visible yet15:57:04
@maryjane_:matrix.orgMaryjaneJust trying to confirm before i send in a PR16:20:56
@elikoga:matrix.orgelikogaCan you clarify what you mean by that?16:36:42
@maryjane_:matrix.orgMaryjanesure! let me give a breakdown on what i did . 16:40:41
@maryjane_:matrix.orgMaryjaneI 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 clarification16:43:47
@maryjane_:matrix.orgMaryjane* 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 clarification16:44:20
@elikoga:matrix.orgelikoga Have you run devmode and reviewed your changes in the live preview that opens after running the command? 16:45:11
@elikoga:matrix.orgelikoga * Have you run devmode like fricklerhandwerk said and reviewed your changes in the live preview that opens after running the command? 16:45:35
@maryjane_:matrix.orgMaryjaneNo I haven't16:46:22
@elikoga:matrix.orgelikoga Please do. After reviewing the changes in the browser tab opened by devmode, you can try building the docs using nix-build nixos/release.nix -A manual.x86_64-linux and open the docs using xdg-open /nix/store/OUTPUTHASHHERE-nixos-manual-html/share/doc/nixos/index.html. You may need to adjust the path to nixos/release.nix depending on your current working directory. 16:49:20
@maryjane_:matrix.orgMaryjane Okay elikoga thank you for clarifying 18:18:23
21 Mar 2025
@egrieco:matrix.orgegrieco joined the room.00:00:03
@domenkozar:matrix.orgDomen Kožar changed their profile picture.11:41:33
23 Mar 2025
@leo:gaspard.ninjaEkleog left the room.16:17:40
@connorbaker:matrix.orgconnor (he/him) (UTC-7) changed their display name from connor (he/him) (UTC-8) to connor (he/him) (UTC-7).18:28:10
24 Mar 2025
@eisfunke:eisfunke.comNicolas changed their display name from Nicolas Lenz to Nicolas.13:41:03

Show newer messages


Back to Room ListRoom Version: 6