!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

414 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
8 Mar 2024
@pennae:matrix.eno.space@pennae:matrix.eno.spacealso consider that nixos-search exists and would do rather better with richer xref medatadata rather than stuff that mostly works in html-only-and-maybe-pdf formats?07:57:51
@pennae:matrix.eno.space@pennae:matrix.eno.space the reason we didn't push for using eg pandoc to generate the docs is that pandoc (and all other frameworks we've looked at then) fails at least one of those tests, and we've already regressed on things to make even that much happen 07:59:08
@jade_:matrix.org@jade_:matrix.org It seems borderline absurd to assume that there exists an off the shelf solution that actually has proper interactions with nix and consideration of anything that is not a web browser. Have you considered taking the nrd output and using it in your pipeline instead of trying to reinvent it, so we actually own the markup parser and such? 07:59:21
@pennae:matrix.eno.space@pennae:matrix.eno.space or, as nrd was intended, change nrd to match the needs 07:59:47
@pennae:matrix.eno.space@pennae:matrix.eno.space (we also find it somewhat backhanded to come up with live editing again when that was already hacked into place and not even possible before the md workflow really took off) 08:07:44
@pennae:matrix.eno.space@pennae:matrix.eno.spacelike, the root problem with our docs isn't tooling support. switching out tooling again will only bind resources that could've been used for something that actually improves that status quo?08:08:54
@infinisil:matrix.orginfinisil
In reply to @jade_:matrix.org
It seems borderline absurd to assume that there exists an off the shelf solution that actually has proper interactions with nix and consideration of anything that is not a web browser. Have you considered taking the nrd output and using it in your pipeline instead of trying to reinvent it, so we actually own the markup parser and such?
Afaik there's nothing Nix-specific about nixos-render-docs at least
09:45:49
@infinisil:matrix.orginfinisil
In reply to @pennae:matrix.eno.space
like, the root problem with our docs isn't tooling support. switching out tooling again will only bind resources that could've been used for something that actually improves that status quo?
I'd say it's a problem that we use different tooling for different projects. I guess it would make sense to try and see if nixos-render-docs could be used throughout though (such as for Nix and nix.dev).
09:48:07

Show newer messages


Back to Room ListRoom Version: 6