!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

437 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
4 Nov 2023
@proofconstruction:matrix.orgproofconstructionThanks for picking up a shovel!15:49:49
@qyriad:matrix.org@qyriad:matrix.orgI had no idea these functions existed before, so thank you for that!15:52:17
@antifuchs:asf.computerantifuchsI would love to make the ToC be auto-generated with an assertion that when adding a section, a tagline is added too17:45:05
@antifuchs:asf.computerantifuchs(this seems difficult, as the lib/ dir is pretty jumbled)18:06:41
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @antifuchs:asf.computer
here's the first PR, to add the lib.meta attrset of functions to the ToC: https://github.com/NixOS/nixpkgs/pull/265478
maybe this project is interesting to you https://nix-community.github.io/docnix/reference/lib/meta/lib-meta-addmetaattrs/ it builds from a fork of nixpkgs not sure how substantial the difference is.
18:29:17
@antifuchs:asf.computerantifuchs Oooh, I didn’t know about that yet! Looks very useful indeed 18:32:43
5 Nov 2023
@atka:matrix.org@atka:matrix.org joined the room.01:18:52
@infinisil:matrix.orginfinisil antifuchs: I do think the order is somewhat important. In particular lib.path, lib.filesystem and lib.sources/lib.fileset should be in that order, because they build up on the previous one 10:54:23
@infinisil:matrix.orginfinisilBut then again, the path library also isn't that important, maybe it ahould come last :P10:55:04
@infinisil:matrix.orginfinisilI guess I don't care very much tbh :)10:55:20
@antifuchs:asf.computerantifuchshahaha, makes sense14:02:03
@antifuchs:asf.computerantifuchsif there are logical groupings, maybe we can arrange them via subsections? but I think in source, having the library attributes be alphabetical would make it much easier to do a mental tally14:02:40
6 Nov 2023
@roberthensing:matrix.orgRobert Hensing (roberth)
In reply to @infinisil:matrix.org
antifuchs: I do think the order is somewhat important. In particular lib.path, lib.filesystem and lib.sources/lib.fileset should be in that order, because they build up on the previous one
that's too much inference, and nobody expect much from an ordered lists, because dependency graphs > 3 nodes are basically never ordered lists
11:51:53
@roberthensing:matrix.orgRobert Hensing (roberth)subsections can only represent trees, and only if they're not too deep, so those are not suitable either11:52:51
@infinisil:matrix.orginfinisilI guess just an introductory section giving an overview of all sublibraries would be better11:53:22
@roberthensing:matrix.orgRobert Hensing (roberth)if at all. Most library reference material doesn't bother with that kind of thing11:54:04
@roberthensing:matrix.orgRobert Hensing (roberth)not sure that we should11:54:11
@alejandrosame:matrix.orgalejandrosame
In reply to @antifuchs:asf.computer
fricklerhandwerk: while I have your attention on the library TOC, do you think it (https://nixos.org/manual/nixpkgs/unstable/#sec-functions-library) should be sorted alphabetically? the order doesn't make much sense to me and that makes it difficult to find things that are missing

For reference documentation I'm also more into alphabetical order and then linking as necessary to building blocks (for example, the proposal in https://github.com/NixOS/nixpkgs/issues/250376).

Other types of documents can order as they want, ofc, since the whole point is to set up an order that makes sense for storytelling, task completion, etc.

12:20:20
@proofconstruction:matrix.orgproofconstruction
In reply to @infinisil:matrix.org
I guess just an introductory section giving an overview of all sublibraries would be better
This would be better as a page on nix.dev
14:36:53
@infinisil:matrix.orginfinisilHmm I think reference docs can also use overviews of its parts, it doesn't really fit into tutorials, guides or explanation14:39:47
@fricklerhandwerk:matrix.orgfricklerhandwerkOverviews are important, and should be right there with the reference docs. Reference will change, and while the prose overview may not catch up immediately, it's way easier to keep it in sync when it's in-tree.14:56:28
@proofconstruction:matrix.orgproofconstruction In case I just mass review-requested everyone on nix.dev, I apologize. I was trying to fix an erroneous push. Who are the administrators of the repo? We should enable branch protection on master to require a PR with approval before merging 16:42:33
@delroth:delroth.net@delroth:delroth.netfun artifact of building nix.dev with flakes: the footer says "Copyright 2016-1980"16:46:24
@delroth:delroth.net@delroth:delroth.net * fun artifact of building nix.dev with nix: the footer says "Copyright 2016-1980"16:46:31
@nbp:mozilla.orgnbpWait, this is not 1970?16:52:28
@alejandrosame:matrix.orgalejandrosame
In reply to @infinisil:matrix.org
Hmm I think reference docs can also use overviews of its parts, it doesn't really fit into tutorials, guides or explanation
The way I see it is like dictionaries: you can add extra sections (intros, overviews, historical explanations, etc) but the indexing of the entries is alphabetical to ease its navigation.
17:02:30
@alejandrosame:matrix.orgalejandrosameI'm with you that being too terse is in general problematic for documentation.17:04:09
@delroth:delroth.net@delroth:delroth.net
In reply to @nbp:mozilla.org
Wait, this is not 1970?
I think 1980 is the default SOURCE_DATE_EPOCH
17:51:44
@nbp:mozilla.orgnbpisn't that the 1st of 1970? To which we added a few seconds because of gnumake?18:02:01
@linus:schreibt.jetztLinux HackermanZIP can only represent dates starting from 1980, my guess is that that's why it would be 1980 and not 197018:04:44

Show newer messages


Back to Room ListRoom Version: 6