!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

403 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
17 Apr 2024
@alex3829:matrix.org@alex3829:matrix.org changed their display name from real_z22 to real_z2.05:33:42
@JoelMcCracken:matrix.orgJoelMcCracken joined the room.16:26:38
18 Apr 2024
@fractivore:cyberia.club@fractivore:cyberia.club left the room.02:27:17
@nscnt:matrix.org@nscnt:matrix.org joined the room.13:21:24
@olafklingt:matrix.org@olafklingt:matrix.orghow is the ":::" annotation called in sphinx? i wonder what the implications of more or less periods is.17:42:57
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @olafklingt:matrix.org
how is the ":::" annotation called in sphinx? i wonder what the implications of more or less periods is.
Admonition
18:10:51
@terru:raccoon.college@terru:raccoon.college oh btw, while we're talking about admonitions: the doc/README.md still contains links to docbook for the types of admonitions which are supported. Is this in any way useful or intentional, or just a migration leftover and therefore a bug? (I found it a little confusing when i noticed it) 19:55:09
19 Apr 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @terru:raccoon.college
oh btw, while we're talking about admonitions: the doc/README.md still contains links to docbook for the types of admonitions which are supported. Is this in any way useful or intentional, or just a migration leftover and therefore a bug? (I found it a little confusing when i noticed it)
Probably a leftover. Feel free to remove the links
08:59:31
@terru:raccoon.college@terru:raccoon.collegesure: https://github.com/NixOS/nixpkgs/pull/30532815:10:08
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @terru:raccoon.college
sure: https://github.com/NixOS/nixpkgs/pull/305328
Thanks!
15:28:02
@terru:raccoon.college@terru:raccoon.college (and while we are on the topic of leftover docbook mentions: anyone got opinions on this issue of mine?) 15:29:11
@djacu:matrix.orgdjacu fricklerhandwerk: infinisil I've created an issue for expanding and improving the module documentation on nix.dev. I would appreciate your and anyone else's feedback.
https://github.com/NixOS/nix.dev/issues/966
16:34:01
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @terru:raccoon.college
(and while we are on the topic of leftover docbook mentions: anyone got opinions on this issue of mine?)
Yeah just ditch those references. Thanks a lot!
17:10:29
@olafklingt:matrix.org@olafklingt:matrix.org I started to think/brainstorm about the NixOS manual again. And i remember that fricklerhandwerk recently said that he thinks "a lot of things in the manual should be on the wiki". What was did you had in mind with of that statement? 19:15:31
@terru:raccoon.college@terru:raccoon.college
In reply to @fricklerhandwerk:matrix.org
Yeah just ditch those references. Thanks a lot!
have opened a PR removing it
19:29:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @olafklingt:matrix.org
I started to think/brainstorm about the NixOS manual again. And i remember that fricklerhandwerk recently said that he thinks "a lot of things in the manual should be on the wiki". What was did you had in mind with of that statement?
All the NixOS-specific interfaces should be documented in the manual. Probably also installation instructions. How to use/troubleshoot particular software can be in the Wiki, because that's not actually about NixOS.
22:22:05
20 Apr 2024
@nscnt:matrix.org@nscnt:matrix.org left the room.13:41:08
@olafklingt:matrix.org@olafklingt:matrix.orgthis closed pr https://github.com/NixOS/nix.dev/pull/964 triggered my brainstorming mind to think about the possibility to have testable tutorials. What if every tutorial is an annotated nixos-test? For me the question is not focused on the style of annotation right now. But rather if you have ideas why an attempt to realize this would be futile? maybe to difficult to realize for potential content contributors (deteriorating)? maybe to complex to implement correctly (endless poc...)?14:52:22

Show newer messages


Back to Room ListRoom Version: 6