!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

437 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
25 Aug 2023
@ryantm:matrix.orgryantmmmdoc15:13:33
@proofconstruction:matrix.orgproofconstruction
In reply to @ryantm:matrix.org
I started updating it and it looks like it's mostly just compatible with the existing docs! I think I can make a super small diff that's not too invasive!
While I think everyone on the docs team agrees that unification of rendering schemes for the manuals is preferable, we haven't had an in-depth discussion around migrating to mmdoc specifically, nor is there really even broad agreement on changing the current system yet. These ideas are very much still in the evaluation phase, rather than planning, so please don't do extra work that might not be used!
20:12:05
@ryantm:matrix.orgryantm proofconstruction: I'm not doing it because I expect you to use it, I'm doing it because I think mmdoc is cool technology that should exist on its own. If it happens to be the best way to solve the unification problem, great. 20:40:49
@ryantm:matrix.orgryantmIn my mind, it has expanded beyond the scope of my original target use case.20:41:18
@proofconstruction:matrix.orgproofconstruction Speaking for myself, I also think it's cool (as mentioned, I generally consult your version of the manual rather than the official one), and I don't personally have objections to using it for the rendering unification project. Just wanted to ping you so you don't spend additional time on it for this purpose 20:46:39
@lucperkins:matrix.orgLuc PerkinsHow extensible is mmdoc, though? I remember playing around with it and I like it that it's lightweight, but how trivial/non-trivial would it be to provide things like admonitions, headings that are linkable on hover, TOCs, footnotes, and other not-quite-standard-Markdown-but-nonetheless-widely-used things?21:24:46
@lucperkins:matrix.orgLuc Perkins * How extensible is mmdoc? I remember playing around with it and I like it that it's lightweight, but how trivial/non-trivial would it be to provide things like admonitions, headings that are linkable on hover, TOCs, footnotes, and other not-quite-standard-Markdown-but-nonetheless-widely-used things?21:24:54
@lucperkins:matrix.orgLuc PerkinsAs far as I can tell, cmark is fairly rigid21:26:04
@lucperkins:matrix.orgLuc Perkins(but I barely know C so my comb through the cmark codebase shouldn't be taken as final 😄)21:26:45
@ryantm:matrix.orgryantmIt already supports admonitions (:::), though not all the formats used by Nixpkgs right now, like it doesn't support anchors inside admonitions.22:41:21
@ryantm:matrix.orgryantmHeaders are already linkable. TOCs is the primary way it works, you have to specify the TOC of each page included. No footnote support currently. https://ryantm.github.io/mmdoc/usage/#usage22:42:43
@ryantm:matrix.orgryantmThe parsers for these various addons are at https://github.com/ryantm/mmdoc/blob/main/src/parse.c22:43:48
@ryantm:matrix.orgryantmcmark has this way of hooking into its renderer to provide your own stuff: https://github.com/ryantm/mmdoc/blob/5f5a2734595cf42167cef2bb3c0e61cdc0185119/src/render.c#L45322:47:42
26 Aug 2023
@lucperkins:matrix.orgLuc PerkinsOkie doke! Not arguing for or against, just curious00:32:46
28 Aug 2023
@mightyiam:matrix.org@mightyiam:matrix.orgSorry. We relocated recently. Lots of house chores. "I'm a software developer!", I keep saying. "Why am I doing plumbing work? Why am I hanging drapes?". Anyway, I'll try to get some progress on extracting the doctester into its own repo soon. That's my update.13:47:55
@mightyiam:matrix.org@mightyiam:matrix.orgThank ya'll for your works.13:48:16
29 Aug 2023
@lurkki:pikaviestin.fiLurkki joined the room.15:42:38
30 Aug 2023
@wackbyte:matrix.orgwackbyte changed their profile picture.20:25:59
31 Aug 2023
@infinisil:matrix.orginfinisilNote that I'll continue abstaining from the doc team meetings for now, probably until after Nixcon12:45:17
@zmitchell:matrix.org@zmitchell:matrix.orgThe Jitsi room says that I need to wait for a moderator to let me in?13:01:48
@zmitchell:matrix.org@zmitchell:matrix.orgThat's pretty new13:02:13
@garbas:matrix.org@garbas:matrix.org zmitchell: I had the same problem yesterday at the marketing meeting. I solved it by creating the account 13:02:51
@zmitchell:matrix.org@zmitchell:matrix.orgInteresting13:03:34
@zmitchell:matrix.org@zmitchell:matrix.orgThanks13:03:38
@qyliss:fairydust.spaceAlyssa Rosshttps://jitsi.org/blog/authentication-on-meet-jit-si/13:04:28
@alejandrosame:matrix.orgalejandrosameI won't be a le to join today's since I'll be in transit13:13:07
@tiagod:matrix.orgtdillenburg joined the room.13:36:21
@asymmetric:matrix.dapp.org.ukasymmetrichey, the decision at the end (not sure whether it was taken or not) felt a bit rushed to me. with just a little more time we could've easily have reached unanimity imo15:10:35
@asymmetric:matrix.dapp.org.ukasymmetrici understand it's not a super high priority decision, but still my pref would've been to dedicate a little bit more time to it15:11:18
@asymmetric:matrix.dapp.org.ukasymmetricwe were only 6 people in the call after all, it should be possible 🙂15:11:40

Show newer messages


Back to Room ListRoom Version: 6