!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

436 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

Load older messages


SenderMessageTime
28 Jun 2023
@sternenseemann:systemli.orgsterniit's only a treewide commit away22:23:17
@pennae:matrix.eno.spacepennaewe've had our share of treewide commits breaking new truths tbh xD22:24:03
@sternenseemann:systemli.orgsternithis is the way23:10:05
@pennae:matrix.eno.spacepennaeif you want to have a go, please do! :)23:18:52
@pennae:matrix.eno.spacepennaehopefully nixdoc#40 makes it in soon so we can fully remove docbook from the nixpkgs manual, after that there's so much opportunity for improvement23:20:16
29 Jun 2023
@asymmetric:matrix.dapp.org.ukasymmetric

Hey, will miss this meeting too unfortunately, sorry for the streak of no-shows, hopefully should end in the next couple of weeks.

The little work I’ve done was reviewing nixdoc. I’ll get to my open PRs on nix.dev asap, but if I’m a blocker, feel free to use your best judgement and merge ahead.

See you soon!

13:08:58
@asymmetric:matrix.dapp.org.ukasymmetric * Hey, will miss this meeting too unfortunately, sorry for the streak of no-shows, hopefully should end in the next couple of weeks.
The little work I’ve done was reviewing nixdoc PRs. I’ll get to my open PRs on nix.dev asap, but if I’m a blocker, feel free to use your best judgement and merge ahead.
See you soon!
14:12:44
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Hey, will miss this meeting too unfortunately, sorry for the streak of no-shows, hopefully should end in the next couple of weeks.
The little work I’ve done was reviewing nixdoc PRs. I’ll get to my open PRs on nix.dev asap, but if I’m a blocker, feel free to use your best judgement and merge ahead.
See you soon!
Thanks for the update.
16:24:01
@fricklerhandwerk:matrix.orgfricklerhandwerk

And again, thanks everyone on the docs and learning journey team. It doesn’t always feel like it on the inside, and it’s not always visible on the outside, but we have taken up enormous momentum. While we’re still have many discussions around finding the right approach and aligning our views, all of you are getting awesome things done, and we’re clearly transitioning into the “performing” phase.

The last few sessions in particular were extraordinarily productive. We’re doing reviews, make decisions, merge changes, and I see a lot of major improvements for user and contributor experience on the horizon.

Don’t get me wrong, it will still take months until everything gets noticeably smoother. But I’m genuinely amazed how we managed to get rolling with a couple of hours a week from everyone.

16:30:32
@pennae:matrix.eno.spacepennaewild idea for the manuals: let's enforce uuids as ids for sections. namespacing of section ids is constantly subverted, and the ids don't convey much useful information anyway16:37:54
@roberthensing:matrix.orgRobert Hensing (roberth)they make link targets readable, which is nicer for readers who share links, and also lets us spot a link target copy paste mistake16:45:39
@roberthensing:matrix.orgRobert Hensing (roberth)similar reason as for the store path name, although that does always include an opaque identifier as well16:46:31
@pennae:matrix.eno.spacepennaeare link targets read or their contents very often? (don't actually know.)16:47:15
@roberthensing:matrix.orgRobert Hensing (roberth)often enough to warrant readability I think. I can't quantify it, but I don't think we need to16:48:24
@pennae:matrix.eno.spacepennaethen maybe we should add a uuid or something else guaranteed to be unique somewhere16:49:22
@pennae:matrix.eno.spacepennae because currently we have eg a #summary id buried deep in the emscripten docs, and that's just the first example we picked from grep 16:49:50
@roberthensing:matrix.orgRobert Hensing (roberth)that one will make sense once we have separate pages, fwiw16:50:39
@roberthensing:matrix.orgRobert Hensing (roberth)unless it's buried really very deep I guess16:50:58
@pennae:matrix.eno.spacepennaenope, ids must be unique within te entire manual16:51:01
@roberthensing:matrix.orgRobert Hensing (roberth)well that's an artificial restriction then16:51:16
@pennae:matrix.eno.spacepennae kind of. otherwise we won't be able to [](#link) them without having to duplicate knowledge of where they are 16:51:33
@roberthensing:matrix.orgRobert Hensing (roberth)most documentation systems do need the location to be part of the identifier, so it'd be a bit weird not to do that16:52:41
@pennae:matrix.eno.spacepennaeit definitely was not an artificial restriction in docbook, and for maintainability's sake we're very opposed to dropping it16:52:47
@roberthensing:matrix.orgRobert Hensing (roberth)yeah it's yet another project16:53:04
@pennae:matrix.eno.spacepennae
In reply to @roberthensing:matrix.org
most documentation systems do need the location to be part of the identifier, so it'd be a bit weird not to do that
arguably that just makes the location part of the id, which does not solve the underlying problem :/
16:53:49
@pennae:matrix.eno.spacepennaethe mismatch from input files to output files that we've now inherited from docbook complicates this even more16:55:37
@alejandrosame:matrix.orgalejandrosameScreenshot from 2023-06-29 18-05-37.png
Download Screenshot from 2023-06-29 18-05-37.png
17:11:12
@alejandrosame:matrix.orgalejandrosameSharing a screenshot of the WIP work on the nixpkgs manual Python section.17:12:09
@fricklerhandwerk:matrix.orgfricklerhandwerkHere's another piece for the survey regarding contributor workflow: https://floxdev.com/blog/nixpkgs-contribution22:37:45
30 Jun 2023
@sternenseemann:systemli.orgsterniwhy can’t nobody at flox proofread such articles (if they are even wise to publish in that context)? Couple of inaccuracies and multiple things that are wrong presented as facts.07:36:05

Show newer messages


Back to Room ListRoom Version: 6