!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

391 Members
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 72 Servers

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


SenderMessageTime
18 May 2024
@danielsidhion:nixos.devdanielsidhion
In reply to @djacu:matrix.org
I can answer some of those questions when I have time. Is it okay to edit that document?
I'm just catching up on (a lot of) discussions, feel free to!
22:40:06
19 May 2024
@deltaflow:matrix.org@deltaflow:matrix.orgFor sure! Going to try and join office hours / do some general lurking. But will compile some thoughts 🙂00:31:37
@antifuchs:asf.computerantifuchs
In reply to @jtojnar:matrix.org
The “I installed a library but my compiler is not finding it. Why?” section disappeared between these two revisions but it is not listed in the diff.
Think this is a diff display bug - selecting “visual” instead of “wikitext” shows the removal.
02:20:50
@djacu:matrix.orgdjacu
In reply to @danielsidhion:nixos.dev
I'm just catching up on (a lot of) discussions, feel free to!

So I created a new column for mkdocs with the Material theme. I've used it in the past and significantly improves the UX of mkdocs. I've answered most of the questions for that combo and I'll try to answer the questions for mkdocs by itself.

I don't understand some of the questions being asked. Could you elaborate on the following?

  • Can we deep-link anywhere in the text? (Do you mean literally anywhere or just headers?)
  • Does it support tagref or anything similar? (Can you give an example?)
  • Does it support the example notation we currently use? (Can you give an example?)
  • Can we get a list of all possible links that someone may use?
  • How can we generate option docs with it? (I was under the impression that option docs can output to json or markdown. And you would want to create a webpage from that?)
  • Can we render it to multiple pages?
  • Can we fit the nixos module documentation in it?
05:23:37
@jtojnar:matrix.orgJan Tojnar
In reply to @antifuchs:asf.computer
Think this is a diff display bug - selecting “visual” instead of “wikitext” shows the removal.
the wikitext diff now shows transclusion removed (I must have missed yesterday?), I have reverted it https://wiki.nixos.org/w/index.php?title=FAQ&diff=prev&oldid=12886
10:19:41
@deltaflow:matrix.org@deltaflow:matrix.orgI've been lurking through the style guide and such. We use plain language and most of the other standards where I work. So this will be fun 🙂19:22:26
20 May 2024
@ckie:ckie.devmei 🌒& changed their display name from ckie (they/them) to mei 🌒&.00:07:24
@alejandrosame:matrix.orgalejandrosameI just pushed a PR to push forward doc autogeneration: https://github.com/NixOS/nixpkgs/pull/31309510:06:44
@alejandrosame:matrix.orgalejandrosame * I just pushed a draft PR to push forward doc autogeneration: https://github.com/NixOS/nixpkgs/pull/31309510:08:42

Show newer messages


Back to Room ListRoom Version: 6