!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

439 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
30 Jun 2023
@pennae:matrix.eno.spacepennaethat's an option too, though we'd have to include the path of the file from the doc root instead of just the file name itself (and that can get pretty long)16:42:55
@pennae:matrix.eno.spacepennae nrd already checks for uniqueness and throws an error on duplicates, but that's a pretty bad experience. and the anchors that are likely to be problematic are exactly the ones that don't convey meaning 16:43:37
@sternenseemann:systemli.orgsterni pennae: just have a list 16:55:11
@sternenseemann:systemli.orgsterniwell then just have meaningful anchors :)16:55:47
@pennae:matrix.eno.spacepennae
In reply to @sternenseemann:systemli.org
well then just have meaningful anchors :)
tell docs authors that D:
16:58:10
@pennae:matrix.eno.spacepennae like. te python chapter has a section with the id faq 16:58:52
@pennae:matrix.eno.spacepennae * like. the python chapter has a section with the id faq 16:59:05
@pennae:matrix.eno.spacepennaethat has been the in-html id for at least a very long time, possibly forever16:59:23
@sternenseemann:systemli.orgsterniI think checking for such things in the manual build is the best solution17:02:52
@sternenseemann:systemli.orgsterniit may always fail, after all17:02:59
@pennae:matrix.eno.spacepennaewe do check, and it has failed in the past17:04:26
@pennae:matrix.eno.spacepennaeat least now it can tell you where shit broke instead of having relaxng slap you with entirely incorrect error locations and messages that aren't worth the photons they're imprinted on17:05:41
1 Jul 2023
@pennae:matrix.eno.spacepennaenixdoc changes for nixpkgs markdowning are merged 🥳12:42:41
@pennae:matrix.eno.spacepennaegoing to update the nixpkgs-side pr in a bit so we can hopefully get that done within the next week12:43:05
@pennae:matrix.eno.spacepennae https://github.com/NixOS/nixpkgs/pull/239636 preliminarily final pr for getting rid of docbook. that really should be it for the entirety of the nixpkgs repo, unless we missed something that's buried deep under the ice 14:13:11
@pennae:matrix.eno.spacepennaehome stretch! 🎉18:59:06
3 Jul 2023
@zmitchell:matrix.org@zmitchell:matrix.orghttps://discourse.nixos.org/t/this-month-in-nix-docs-3-may-june-2023/2995816:56:29
@zmitchell:matrix.org@zmitchell:matrix.orgFeel free to post a comment if I got something wrong16:57:06
@pennae:matrix.eno.spacepennaedamn, has it been two months again 😨17:00:18
@zmitchell:matrix.org@zmitchell:matrix.org I too forgot that time marches forward regardless of my protests 17:01:37
@pennae:matrix.eno.spacepennaefwiw the docbook toolchain also allows fragmenting a document into multiple outputs (nixos manual and epubs used that), but it's horrid to configure and still all docbook :/17:20:07
@pennae:matrix.eno.spacepennae moving away from xhtml outputs going to fun. ncfavier, any idea how much that would break? 17:20:51
@pennae:matrix.eno.spacepennaeeg, does nixos-search use docbook/xhtml?17:21:39
@pennae:matrix.eno.spacepennaethe homepage runs xslt over manual xhtml, which is going to ... Great 😞17:22:39
@ncfavier:matrix.orgncfavier
In reply to @pennae:matrix.eno.space
eg, does nixos-search use docbook/xhtml?
i don't think so
17:37:04
@pennae:matrix.eno.spacepennaethat's good already :)17:38:14
@ncfavier:matrix.orgncfavierwe just render (previously docbook/) markdown snippets to html with pandoc. btw, it would be nice if we could use nixos-render-docs to do that17:38:18
@ncfavier:matrix.orgncfavierthat way we don't need to keep link-manpages.nix around17:38:39
@pennae:matrix.eno.spacepennaethat pretty much just needs a new options render mode that returns a collection of fragments instead of a document, shouldn't be that much work17:39:14
@pennae:matrix.eno.spacepennaethe infra needed to do that is there and used internally to speed up options rendering, it pretty much only needs exported as a mode17:39:48

Show newer messages


Back to Room ListRoom Version: 6