!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

417 Members
Discussion about documentation improvements around the Nix ecosystem89 Servers

Load older messages


SenderMessageTime
8 Aug 2022
@Ericson2314:matrix.orgJohn Ericsonthe other documentation quadrants handle brevity and clarity12:25:40
@Ericson2314:matrix.orgJohn EricsonOf course, this is an argument for just folding the abstract stuff in the concrete sections too, because12:26:07
@Ericson2314:matrix.orgJohn Ericson * Of course, this is an argument for just folding the abstract stuff in the concrete sections too :) because there is no hard reason it can't just be longer sections with more information in a reference12:26:42
@Ericson2314:matrix.orgJohn Ericson

but it will not be helpful for the vast majority of software developers who just want do get their job done - our targeted audience!

12:27:19
@Ericson2314:matrix.orgJohn Ericson *

but it will not be helpful for the vast majority of software developers who just want do get their job done - our targeted audience!

The target audience a reference for me is people who don't just care about getting a job done, but want to understand it more completely

12:27:44
@Ericson2314:matrix.orgJohn Ericson

I agree that there is a meta-topic about content-addressing, immutability, and theory of computaton, but I deem it very much out of scope for Nix documentation.

It's not supposed to be a theory of things in general, it is supposed to be a theory of just Nix. I can fold together every abstract--concrete pair, but I do need to say what all the various types of store objects, drvs, etc. have in common at some point

12:29:01
@Ericson2314:matrix.orgJohn EricsonAnyways I am first going to try to finish the concrete spec info13:12:58
@Ericson2314:matrix.orgJohn Ericsonbut then I will try to make the abstract part less philosphical13:13:16
9 Aug 2022
@tpw_rules:matrix.orgtpw_ruleshttps://github.com/NixOS/nix/issues/662302:13:29
@tpw_rules:matrix.orgtpw_rules * is there an alternate branch or something with the new nix documentation rendered?02:13:44
@tpw_rules:matrix.orgtpw_rulesi saw it was commented out from the official docs shortly after it was merged02:13:51
@asymmetric:matrix.dapp.org.ukasymmetricshould we remove experimental commands from the stable nix manual?10:12:16
@asymmetric:matrix.dapp.org.ukasymmetric e.g. https://nixos.org/manual/nix/stable/advanced-topics/post-build-hook.html?highlight=sign#implementing-the-build-hook uses nix store sign 10:12:28
@rapenne-s:tchncs.deSolène Rapenne (she/her) changed their display name from Solène (she/her) to Solène Rapenne (she/her).15:14:25
@bjth:matrix.orgBryan Honof joined the room.15:33:02
@ksoda:matrix.orgKen Sonoda joined the room.16:00:11
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
should we remove experimental commands from the stable nix manual?
In the documentation team so far we have consensus that, yes, we should not assume or nudge people to use what is not stable. But we also want to document flakes as good as we can, ideally to be ready in sync with a stable release.
16:14:04
@ksoda:matrix.orgKen Sonoda set a profile picture.16:24:10
10 Aug 2022
@praduca:matrix.orgFlávio Martins Prado joined the room.05:45:16
@praduca:matrix.orgFlávio Martins PradoHi, just noted that the link to matrix on the manual preface is broken05:45:54
@praduca:matrix.orgFlávio Martins Pradoshould a report be open or one just correct on nixpkgs directly?05:46:24
@winterqt:nixos.devWinter (she/her)Which manual? There may be an extra step to take depending on the manual.05:50:04
@winterqt:nixos.devWinter (she/her)But yes, opening a PR is preferred if you want to do so :)05:50:20
@praduca:matrix.orgFlávio Martins Pradois thenixos manual05:57:24
@praduca:matrix.orgFlávio Martins Pradosorry nixpkgs manual05:58:29
@praduca:matrix.orgFlávio Martins Pradoits wrong on both actually06:01:51
@praduca:matrix.orgFlávio Martins Pradook i will open the report, there is some template for reporting on the documentation? (there is for bugs)06:03:41
@praduca:matrix.orgFlávio Martins Pradodang i read gug report lol i will correct and commit the correction:)06:07:27
@luxus:furiosa.orgluxus joined the room.09:56:48
@luxus:furiosa.orgluxus fricklerhandwerk: thanks for your lecture.. i really felt stupid yesterday for not understanding. vielen danke 😄 10:01:54

There are no newer messages yet.


Back to Room ListRoom Version: 6