!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

395 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
11 Mar 2025
@me:linj.techlinj 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
@me:linj.techlinj * 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
@me:linj.techlinj * 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
@me:linj.techlinj * 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @me:linj.tech
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?
I 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
@federicodschonborn:matrix.orgWormy McWormface 🏳️‍🌈 (he/they) changed their display name from Federico Damián (he/they) to This Federico Damián is licensed under the terms of the he/him or they/them pronouns, at your choice.23:21:09
12 Mar 2025
@vidariondr:matrix.orgvidariondr joined the room.21:09:09
15 Mar 2025
@isabel:isabelroses.comisabel changed their profile picture.14:47:00
@shamrocklee:matrix.orgShamrockLee (Yueh-Shun Li) joined the room.21:06:35
16 Mar 2025
@federicodschonborn:matrix.orgWormy McWormface 🏳️‍🌈 (he/they) changed their display name from This Federico Damián is licensed under the terms of the he/him or they/them pronouns, at your choice to This LEGO® Worm™ is licensed under the terms of the he/him or they/them pronouns, at your choice.15:12:17
@isabel:isabelroses.comisabel changed their profile picture.17:40:03
18 Mar 2025
@maryjane_:matrix.orgMaryjane joined the room.09:32:11
@maryjane_:matrix.orgMaryjaneHello 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
@maryjane_:matrix.orgMaryjaneHaving read the documentation guide, i will like to be directed on how to begin my contribution09:49:13
@fricklerhandwerk:matrix.orgfricklerhandwerk 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
@elvishjerricco:matrix.org@elvishjerricco:matrix.org joined the room.23:55:43
@elvishjerricco:matrix.org@elvishjerricco:matrix.org

So I'm factoring out a repeatedly used type into types.nix here: https://github.com/NixOS/nixpkgs/pull/375975/files#diff-64168148acd9f2147ef733b1498b8821c24f2e3f32354b0e147dd421d71274f3R1165-R1171

Does this need to be documented in option-types.section.md? And if so, under which section does it seem appropriate?

23:59:06
@elvishjerricco:matrix.org@elvishjerricco:matrix.org(apologies if this room isn't about nixpkgs/nixos docs; I wasn't sure)23:59:33
19 Mar 2025
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @elvishjerricco:matrix.org

So I'm factoring out a repeatedly used type into types.nix here: https://github.com/NixOS/nixpkgs/pull/375975/files#diff-64168148acd9f2147ef733b1498b8821c24f2e3f32354b0e147dd421d71274f3R1165-R1171

Does this need to be documented in option-types.section.md? And if so, under which section does it seem appropriate?

Yes please, as long as that section is not auto-generated from doc comments
07:34:34
@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

Show newer messages


Back to Room ListRoom Version: 6