!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

434 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
6 Aug 2022
@tpw_rules:matrix.orgtpw_rulesbut on the other hand, a lot of the existing nix material feels like what you said: "a big bag of special cases with the underlying theme left as an exercise to the reader"18:07:44
@tpw_rules:matrix.orgtpw_rules(and tooling...)18:07:48
@tpw_rules:matrix.orgtpw_rulesis that just the nature of nix? should the Grand Unified Theory be at the end of the reference?18:09:00
@Ericson2314:matrix.orgJohn Ericsonoh oops20:21:07
@Ericson2314:matrix.orgJohn Ericsonmore grand unified theory sure, and more trying to get upstream stuff to think about us so there is less "no one anticipated this" friction20:21:34
@yuu:matrix.orgyuu changed their display name from yuu[m] to yuu.20:34:47
@wentasah:matrix.orgwentasah joined the room.22:14:56
7 Aug 2022
@tpw_rules:matrix.orgtpw_ruleswhat i'm saying is i wonder if the reference should be introduced in more practical terms first. 00:20:18
@tpw_rules:matrix.orgtpw_rulesi.e. swap the concrete model and the abstract model in the toc00:20:43
@cnn_npc:envs.netcnn_npc joined the room.08:57:56
@ShadowRZ:matrixim.cc夜坂雅 | Yorusaka Miyabi joined the room.09:03:57
8 Aug 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk

John Ericson: We've extensively talked about this in the course of developing the architecture docs. I have a clear opinion on this, but it's kind of hard to formulate briefly.

  1. it's a trade-off between brevity/clarity, length, and completeness
  2. it's a trade-off in terms of invested effort
  3. the ultimate goal in this scope is to help people understand Nix enough to make best use of it

writing even the part that got merged and commented out again took weeks of wall-clock time, and many full work days user time. I think we struck a very good balance so far, because the contents are very specific to Nix while still introducing an idea of the overarching theme, and still got it brief enough for people to consume in an afternoon, and precise enough to get back for details.

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 is not the place to introduce or explain any of that. If there were a reference on that, we could gladly mention it as an alternative venue to understanding Nix, but it will not be helpful for the vast majority of software developers who just want do get their job done - our targeted audience! Just as I think it was (and still is, my PR to change that is yet to be merged) a big mistake trying to explain Nix in terms of Haskell to an audience that on average struggles to understand Haskell to an even greater extent. It may be true that Nix appears like a special case of something more general to Haskellers, it is a minority that does not need help anyway.

So, I would prefer to stick to Nix specifics and only keep hinting at the bigger picture, because Nix works right now.

10:42:20
@Ericson2314:matrix.orgJohn Ericson fricklerhandwerk: So for me the downsides are clear but narrow 12:24:52
@Ericson2314:matrix.orgJohn Ericson

it's a trade-off between brevity/clarity, length, and completeness

I reference needs to be complete

12:25:02
@Ericson2314:matrix.orgJohn Ericson *

it's a trade-off between brevity/clarity, length, and completeness

A reference needs to be complete

12:25:07
@Ericson2314:matrix.orgJohn EricsonTrading completeness for anything else in a reference I think is basically pandering12:25:25
@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

Show newer messages


Back to Room ListRoom Version: 6