!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

412 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
15 May 2024
@phaer:matrix.orgphaerI remember seeing a pad with a table comparing different markdown implementations in the context of how useful they would be for nix(os) documentation. But I can't find it anymore. Does anyone have a link and/or the answer on which implementation has been chosen in the end?07:21:03
@phaer:matrix.orgphaerSeems to be markdown-it-py, according to https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/tools/nix/nixos-render-docs/default.nix#L63 :)07:37:52
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phaer:matrix.org
I remember seeing a pad with a table comparing different markdown implementations in the context of how useful they would be for nix(os) documentation. But I can't find it anymore. Does anyone have a link and/or the answer on which implementation has been chosen in the end?

danielsidhion made an overview here: https://ethercalc.net/dc4vcnnl8zv0

Also linked from here: https://discourse.nixos.org/t/a-roadmap-for-the-documentation-ecosystem/42328

08:09:37
@fricklerhandwerk:matrix.orgfricklerhandwerkBTW it's documentation office hours again: https://jitsi.lassul.us/nix-documentation08:16:00
@raghavsood:matrix.orgraghavsood joined the room.08:28:19
@raghavsood:matrix.orgraghavsood set a profile picture.08:38:25
@soenkeklinger:matrix.orgSoenke KlingerShould I use the stable or the unstable manual when I place a link from the the Wiki to the manual?14:33:03
@soenkeklinger:matrix.orgSoenke Klinger * Should I use the stable or the unstable manual when I place a link from the the Wiki to the NixOS manual?14:33:59
@infinisil:matrix.orginfinisil Soenke Klinger: Preferably the stable one 14:39:11
16 May 2024
@fricklerhandwerk:matrix.orgfricklerhandwerkDocumentation office hours starting in a couple of minutes: https://jitsi.lassul.us/nix-documentation14:27:00
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

infinisil: can I get some more feedback for this PR. https://github.com/nix-community/nixdoc/pull/121
I'd be super happy if we get this merged, since we broke the last 2 versions of nixdoc. (at least for nixpkgs manual)

Also roberth opened a PR that is waiting for new features in nixdoc. Which are in a follow up PR.

14:35:05
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostthis one: https://github.com/NixOS/nixpkgs/pull/30584714:35:59
@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

Show newer messages


Back to Room ListRoom Version: 6