!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

Load older messages


SenderMessageTime
24 Aug 2023
@raitobezarius:matrix.orgraitobezariusI honestly prefer the 50 km long page :P22:51:46
@raitobezarius:matrix.orgraitobezariusBut I think offering both is not bad at all22:51:54
@ryantm:matrix.orgryantmMany people have told me they like it better than the official manual. I should commit to an update at least every release.23:50:07
@ryantm:matrix.orgryantm!00% not going to make my SEO worse in some way as long as people are telling me they prefer my manual rendering.23:55:40
@ryantm:matrix.orgryantmI'll try to update it this weekend!23:58:35
25 Aug 2023
@raitobezarius:matrix.orgraitobezariusThank you00:05:12
@dylandoesprogramming:matrix.org@dylandoesprogramming:matrix.org left the room.00:05:36
@raitobezarius:matrix.orgraitobezariusThat being said, I feel like it would help a lot to get this "alternative" rendering merged somehow00:06:40
@raitobezarius:matrix.orgraitobezariusI don't have a big opinion on the rendering, but I personally find it hard to navigate the mdbook style and I prefer the long page, some prefers the mdbook and that's fine, we just have contributors who don't know what to do when folks are enforcing rules from the outdated mdbook manual00:07:29
@proofconstruction:matrix.orgproofconstructionUnifying the rendering infrastructure for all the manuals has been discussed often and is on the roadmap https://github.com/nix-community/projects/issues/6, but we don't have the time/energy/(funds to throw at it)/etc currently00:13:20
@raitobezarius:matrix.orgraitobezariusUnderstandable00:15:24
@ryantm:matrix.orgryantm
In reply to @proofconstruction:matrix.org
Unifying the rendering infrastructure for all the manuals has been discussed often and is on the roadmap https://github.com/nix-community/projects/issues/6, but we don't have the time/energy/(funds to throw at it)/etc currently
This is why I made mmdoc in the first place. I wanted to make a documentation rendering system that was lightweight enough to be kept on as part of nixos-rebuild and didn't add to the closure size.
13:44:17
@ryantm:matrix.orgryantmTotally get that I didn't put in the effort to push it over the finish line though, wish I had that energy.13:54:31
@ryantm:matrix.orgryantmI 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!15:01:00
@raitobezarius:matrix.orgraitobezariusyou mean nrd or mmdoc or something else?15:06:26
@janik0:matrix.org@janik0:matrix.org joined the room.15:11:18
@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

Show newer messages


Back to Room ListRoom Version: 6