!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

380 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

Load older messages


SenderMessageTime
16 May 2024
@infinisil:matrix.orginfinisil Johannes Kirschbauer @hsjobeki: I'll try to take a look later! 16:28:44
17 May 2024
@djacu:matrix.orgdjacu

Hey team

I'm working on migrating the first module lesson for review. I started the dev environment with nix-shell --run devmode but every change I make requires a page refresh which takes 20+ seconds. Is this normal or am I doing something wrong?

02:02:06
@infinisil:matrix.orginfinisil djacu: Unfortunately that's as expected, I think it uses nix-build underneath 😅 02:12:36
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @infinisil:matrix.org
djacu: Unfortunately that's as expected, I think it uses nix-build underneath 😅
Yes, and unfortunately that's still better than Sphinx randomly not updating stuff that changes. I was so fed up with it that I took the performance hit
02:22:39
@djacu:matrix.orgdjacu
In reply to @fricklerhandwerk:matrix.org
Yes, and unfortunately that's still better than Sphinx randomly not updating stuff that changes. I was so fed up with it that I took the performance hit

laughs/cries in mkDocs

But seriously, if we want to have a discussion about mkDocs, I have had experience with it. I can't remember who, but I spoke with someone on the docs team about it like a month ago.

02:24:46
@djacu:matrix.orgdjacu
In reply to @fricklerhandwerk:matrix.org
Yes, and unfortunately that's still better than Sphinx randomly not updating stuff that changes. I was so fed up with it that I took the performance hit
*

laughs/cries in mkDocs

But seriously, if we want to have a discussion about mkDocs, I have had experience with it. I can't remember who, but I spoke with someone on the docs team about it like a month ago (and it was mentioned during the meeting today).

02:25:08
@djacu:matrix.orgdjacuAlright first lesson is up for review. https://github.com/NixOS/nix.dev/pull/98203:14:52
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @djacu:matrix.org

laughs/cries in mkDocs

But seriously, if we want to have a discussion about mkDocs, I have had experience with it. I can't remember who, but I spoke with someone on the docs team about it like a month ago (and it was mentioned during the meeting today).

danielsidhion: Was carrying together more documentation frameworks pros and cons. Ideally we'd find some architectural solution/improvement for the nix-ecosystem as a whole. But thats another long story.
15:29:06
@djacu:matrix.orgdjacu
In reply to @johannes.kirschbauer:scs.ems.host
danielsidhion: Was carrying together more documentation frameworks pros and cons. Ideally we'd find some architectural solution/improvement for the nix-ecosystem as a whole. But thats another long story.
Did they collect their findings anywhere?
15:36:57
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host https://ethercalc.net/dc4vcnnl8zv0 15:43:23
@djacu:matrix.orgdjacu
In reply to @johannes.kirschbauer:scs.ems.host

https://ethercalc.net/dc4vcnnl8zv0
I can answer some of those questions when I have time. Is it okay to edit that document?
16:20:27
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostHm. Not sure this belongs to danielSidhion. Id at least not delete stuff, but if you know some answers that you'd save a lot of time i guess.16:38:01
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Hm. Not sure this belongs to danielSidhion. I'd at least not delete stuff, but if you know some answers that you'd save a lot of time i guess.16:38:08
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
Hm. Not sure this belongs to danielSidhion. I'd at least not delete stuff, but if you know some answers that you'd save a lot of time i guess.
If it’s not world writable you can always fork it and paste it under the discourse post where it’s linked outlining
16:38:52
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
Hm. Not sure this belongs to danielSidhion. I'd at least not delete stuff, but if you know some answers that you'd save a lot of time i guess.
* If it’s not world writable you can always fork it and paste it under the discourse post where it’s linked
16:39:02
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostIts editable, thats why he asks ;)16:39:16
@deltaflow:matrix.org@deltaflow:matrix.org joined the room.19:15:50
@djacu:matrix.orgdjacu

Hey team

I met null in the JB Nix Nerds matrix space. We've been chatting about how they can get involved and they mentioned they are a Technical Writer. They said they would like to help out so I invited them here and gave them a link to the nixos calendar.

19:21:06
@deltaflow:matrix.org@deltaflow:matrix.orgHi all, love Nix, love the community, and looking to help out wherever I can. I'm in technical writing/editing/knowledge management for a telecommunications company by trade, so hoping I can use those skills here.19:31:48
@olaf_freund:matrix.orgOlaf Krasicki Freund joined the room.22:47:53
18 May 2024
@jtojnar:matrix.orgJan Tojnarwhat the heck is happening here? https://wiki.nixos.org/w/index.php?title=FAQ&diff=11690&oldid=1168911:09:44
@jtojnar:matrix.orgJan TojnarThe “I installed a library but my compiler is not finding it. Why?” section disappeared but it is not listed in the diff.11:09:59
@jtojnar:matrix.orgJan Tojnar * 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.11:10:16
@olafklingt:matrix.org@olafklingt:matrix.org left the room.17:04:09
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @deltaflow:matrix.org
Hi all, love Nix, love the community, and looking to help out wherever I can. I'm in technical writing/editing/knowledge management for a telecommunications company by trade, so hoping I can use those skills here.
Would love to e-meet you! Maybe you can already provide some feedback on the general state of affairs with documentation?
20:04:07
@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

Show newer messages


Back to Room ListRoom Version: 6