!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

354 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
3 Jul 2021
@ryantm:matrix.orgryantm Jan Tojnar probably but why? 13:10:52
@jtojnar:matrix.orgJan TojnarI am still not very happy about keeping generated code in the repo 🤷‍♀️13:12:39
5 Jul 2021
@spacesbot:nixos.devspacesbot - keeps a log of public NixOS channels joined the room.19:20:30
@spacesbot:nixos.devspacesbot - keeps a log of public NixOS channels 19:49:29
@ncfavier:matrix.orgncfavier changed their profile picture.23:32:32
6 Jul 2021
@spacesbot:nixos.devspacesbot - keeps a log of public NixOS channels changed their display name from spacesbot to spacesbot - keeps a log of public NixOS channels.22:11:45
8 Jul 2021
@jtojnar:matrix.orgJan Tojnar ryantm: another benefit would be converting option descriptions to markdown 16:22:51
@jtojnar:matrix.orgJan Tojnarwhich would help https://github.com/NixOS/nixos-search/issues/30316:23:03
@multivariante:matrix.orgmultivariante joined the room.22:20:47
@multivariante:matrix.orgmultivariante left the room.22:21:13
12 Jul 2021
@jtojnar:matrix.orgJan Tojnar ryantm: I like that the link name and target is decoupled 22:49:42
@jtojnar:matrix.orgJan Tojnaralso I needed some syntax to use for docbook-to-markdown conversion22:50:25
@jtojnar:matrix.orgJan Tojnarand currently, MyST looks like the only contender for the docs anyway https://github.com/NixOS/nixpkgs/pull/10503622:50:58
@jtojnar:matrix.orgJan Tojnar * ryantm: I like that the link name and target is decoupled, especially for option documentation 22:53:35
@ryantm:matrix.orgryantm Jan Tojnar: link name and target can already be decoupled in basic CommonMark on the per-document level. 23:08:58
@jtojnar:matrix.orgJan TojnarI meant for the option documentation23:09:32
@jtojnar:matrix.orgJan Tojnarit will also allow us to swap the links locally (in the produced manpage)23:10:21
@ryantm:matrix.orgryantm Jan Tojnar: What's stopping mmdoc from being a contender for you? 23:28:24
@jtojnar:matrix.orgJan Tojnar ryantm: I though it was mostly meant as temporary demo 23:29:07
@ryantm:matrix.orgryantm Jan Tojnar: I made it because the NixOS manual needs a small closure-size renderer. I was hoping it could be made be good enough for all the manuals though, for consistency sake. 23:30:27
@ryantm:matrix.orgryantmI also like how fast it is. It should be pretty easy to set up some live-reload kind of thing.23:31:49
@jtojnar:matrix.orgJan Tojnarthen there is the issue with extensibility – it is basically impossible to do anything more interesting without forking cmark-gfm23:35:55
@jtojnar:matrix.orgJan Tojnarand the other C library I found (lowmark) is extensible but basically frozen23:36:56
@ryantm:matrix.orgryantmMaybe we do not need too much extensibility. The more we extend it, the more complicated it is for authors to use. I think that is part of the point of moving away from DocBook.23:38:11
@jtojnar:matrix.orgJan Tojnaryeah, but the RFC also agreed that the plain CommonMark is too little23:41:35
@jtojnar:matrix.orgJan Tojnarand even basic stuff like admonitions is currently super hacky23:42:12
@jtojnar:matrix.orgJan Tojnarif we want to maintain our own solution, it should be at least easy, IMO23:44:15
@ryantm:matrix.orgryantmFair enough. I did throw together the extensions I added very quickly.23:46:33
@ryantm:matrix.orgryantmI'm planning to keep working on mmdoc, and I have some time over the next couple weeks, so hopefully I can improve it a bunch.23:48:00
@jtojnar:matrix.orgJan Tojnaryou did good job, the API will not allow you do much better23:48:47

Show newer messages


Back to Room ListRoom Version: 6