!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

421 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
12 Jan 2024
@danielsidhion:nixos.devdanielsidhion Should we update https://github.com/NixOS/nixos-homepage/blob/master/scripts/update.sh to use nix flake update instead of nix flake lock then? 16:37:51
@infinisil:matrix.orginfinisil danielsidhion: I might do that yeah 16:39:00
@infinisil:matrix.orginfinisil(If 2.19.1 actually supports that already)16:39:33
@danielsidhion:nixos.devdanielsidhionI think it does, if the docs I'm reading are right16:40:20
@infinisil:matrix.orginfinisilYeah16:42:32
@infinisil:matrix.orginfinisilBut it doesn't support updating multiple inputs in a single command :/16:43:53
@mcdonc:matrix.orgChris McDonough danielsidhion: if i could ask in context, it looks like https://github.com/NixOS/nixpkgs/pull/280520 adds an "Inputs" title... should there be a corresponding "Outputs"? 16:45:16
@mcdonc:matrix.orgChris McDonoughOr I guess "Output" heh16:46:36
@danielsidhion:nixos.devdanielsidhionAdd an "output/outputs" if it makes sense. The example I put there might be somewhat bad and need rework, because I had in mind a function that outputs a derivation, so "passthru outputs" makes more sense16:48:58
@danielsidhion:nixos.devdanielsidhionFor lib-style functions it might make more sense to use "output/outputs"16:49:34
@mcdonc:matrix.orgChris McDonoughok, i think that makes sense16:49:59
@mcdonc:matrix.orgChris McDonoughin that trivial builders file, we have sort of haskell-style "runCommand :: String -> AttrSet -> String -> Derivation" style of documenting inputs and outputs... i'm going to remove those and go with that16:51:23
@infinisil:matrix.orginfinisil danielsidhion: https://github.com/NixOS/nixos-homepage/pull/1199 16:52:46
@danielsidhion:nixos.devdanielsidhionIf that style of documenting inputs/outputs doesn't work well for your use case, please help improve the conventions by either adding more specific cases or helping find a common abstraction that works for more cases16:53:22
@danielsidhion:nixos.devdanielsidhionWe're kind of making those conventions as I find the opportunities while working on the manual16:53:38
@mcdonc:matrix.orgChris McDonoughyep... i don't personally think the "runCommand :: String -> AttrSet -> String -> Derivation" style is very useful so i'll replace it with what we talked about and we'l see what happens :)16:54:31
@mcdonc:matrix.orgChris McDonoughif CI completes, could we merge https://github.com/NixOS/nixpkgs/pull/277534 as-is so far? rationale: i don't want to make more commits to it that are unrelated to the writeText* functions, which is what its about right now17:24:55
@mcdonc:matrix.orgChris McDonough(i'd like to make more changes to it that are related to function argument styles)17:25:15
@mcdonc:matrix.orgChris McDonough(but that are not related to writeText* funcs)17:25:46
@danielsidhion:nixos.devdanielsidhionI'm reviewing the pr right now17:33:26
@jade_:matrix.org@jade_:matrix.org
In reply to @asymmetric:matrix.dapp.org.uk
i think we would really benefit from this. it would make it easier for people to contribute across the different projects on the platform, create links when appropriate, etc etc
there's a bunch of efforts of unclear relation involving writing new docs builders. we really need to write down what they are and probably make a tracking issue to try to not step on our own toes.
18:20:29
@infinisil:matrix.orginfinisil danielsidhion: Manual is now being updated again! https://nixos.org/manual/nixpkgs/unstable/ 19:40:43
@infinisil:matrix.orginfinisil(merged the PR and manually triggered an update)19:40:56
@danielsidhion:nixos.devdanielsidhionThank you for fixing it!19:41:26
@danielsidhion:nixos.devdanielsidhion
In reply to @jade_:matrix.org
there's a bunch of efforts of unclear relation involving writing new docs builders. we really need to write down what they are and probably make a tracking issue to try to not step on our own toes.
I think that's important, added this to the agenda for next meeting so it's not forgotten to be at least discussed, hopefully the issue is created during the meeting though
19:43:53
@asymmetric:matrix.dapp.org.ukasymmetric jade_: what projects/efforts are you thinking of? i know of nixos-render-docs (which is actually used in nixpkgs/nixos), mmdoc (which was supposed to be used, but isnt'). anything else? 20:40:07
@asymmetric:matrix.dapp.org.ukasymmetric relatedly, i was looking into the pr splitting the nixpkgs manual up, which uses mmdoc, and i think it should probably be re-implemented using nrd? 20:49:44
@asymmetric:matrix.dapp.org.ukasymmetricmainly because, afaict, nrd is the sanctioned way forward20:50:34
@jade_:matrix.org@jade_:matrix.orgthis one, which claims to "complete autogenerated documentation for the whole nix-ecosystem" (which is fundamentally contradictory with all the other projects ostensibly doing this but having nothing to do with it): https://github.com/nix-community/docnix20:53:12
@jade_:matrix.org@jade_:matrix.orgthe description of this and how it fits into the way everything is going to fit together is very fundamentally confusing20:53:54

Show newer messages


Back to Room ListRoom Version: 6