!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

378 Members
Discussion about documentation improvements around the Nix ecosystem81 Servers

Load older messages


SenderMessageTime
3 Mar 2025
@bendanm:matrix.orgbendanm joined the room.04:43:52
4 Mar 2025
@lassulus:lassul.uslassulus changed their profile picture.17:49:04
7 Mar 2025
@qyriad:katesiria.orgQyriad changed their display name from Qyriad to qyriad.16:02:38
8 Mar 2025
@ncfavier:matrix.orgnf changed their profile picture.10:43:25
@qyriad:katesiria.orgQyriad changed their display name from qyriad to Qyriad.21:41:03
10 Mar 2025
@ayatsfer:matrix.orgFernando joined the room.15:29:10
@ayatsfer:matrix.orgFernando 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @ayatsfer:matrix.org
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
Thanks, appreciated! Feel free to discuss further ideas here, love to hear your thoughts on where you want to take it
17:25:25
@charles:computer.surgeryCharles left the room.22:30:07
11 Mar 2025
@ayatsfer:matrix.orgFernando 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
@ayatsfer:matrix.orgFernandoso if other people wanting to document their modules use it, then great. But if I'm the only user then it's fine too08:04:47
@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.orgThe Worm 🏳️‍🌈 (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.orgThe Worm 🏳️‍🌈 (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

Show newer messages


Back to Room ListRoom Version: 6