!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
6 Feb 2024
@fractivore:cyberia.clubSYMYƧ
In reply to @dmills27:matrix.org
Greetings everyone,

Season of Docs opened up their applications on the 2nd of February. I wanted to check with you guys if you're fine with me coordinating this activity for the NixOS Foundation? I have previously successfully managed a prior Season of Docs participant in 2022 (see 'Talawa' in https://developers.google.com/season-of-docs/docs/2022/participants). If everyone agrees, I can draft a CFP in the following days that details the strategies we could use for this edition of the programme.
Erm, whatever it's worth, I am 100% fine with that 😆 ( the emoji is because I'm a noob, and while my opinion is still valid, there is truly very little weight to my opinion in this situation )
13:22:50
@fractivore:cyberia.clubSYMYƧ
In reply to @danielsidhion:nixos.dev
Also on the technical bits: the "nix-shell entry subroutine" box should ideally be inside the "nix-shell" box
Huge thanks. Would you be willing to elaborate more on the details of nix-shell as a process, and/or know where I can read more about it? I've had a tough time finding the source code! It's not really discoverable in the same way nixpkgs source is (it's not in nixpkgs....? right?) , and it's also not a very easy thing to search for, due to the huge amount of ambiguity (nix shell vs nix-shell vs Now open up a shell and install nix...).
13:40:05
@fractivore:cyberia.clubSYMYƧI read the manual, but it's a manual - intended for usage rather than understanding.13:41:11
@qyriad:matrix.org@qyriad:matrix.orgIt's not in Nixpkgs, confusingly it's in NixOS/nix/src/nix-build/nix-build.cc https://github.com/NixOS/nix/blob/master/src/nix-build/nix-build.cc13:43:17
@fractivore:cyberia.clubSYMYƧ
In reply to @infinisil:matrix.org
It's not done yet, but the [thunks tutorial](https://github.com/NixOS/nix.dev/pull/824) could really use diagrams. Haskell has an entire package for visualising thunks in practise even: https://dennis.felsing.org/ghc-vis/
This is a completely new concept to me (thunks) , so I'll need to do some reading first, but thanks for the direction.
15:01:35
@danielsidhion:nixos.devdanielsidhion
In reply to @fractivore:cyberia.club
Huge thanks. Would you be willing to elaborate more on the details of nix-shell as a process, and/or know where I can read more about it? I've had a tough time finding the source code! It's not really discoverable in the same way nixpkgs source is (it's not in nixpkgs....? right?) , and it's also not a very easy thing to search for, due to the huge amount of ambiguity (nix shell vs nix-shell vs Now open up a shell and install nix...).
Aside from the source code already provided, I don't have any specific resources to link to. The concept of a shell and processes are more generic and not particular to nix, so to learn more about those, you'll have to learn a bit about operating systems. nix-shell is mostly just a regular shell with some extra stuff on top as you detailed in your diagram
15:49:09
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @qyriad:matrix.org
It's not in Nixpkgs, confusingly it's in NixOS/nix/src/nix-build/nix-build.cc https://github.com/NixOS/nix/blob/master/src/nix-build/nix-build.cc
symys: Not only is it confusing - the flagship feature we put on the front page is a really ugly wart architecturally. Maybe the ugliest. We’re still discussing how to maneuver away from it and still provide the same or better level of convenience and maintainability, but it requires pulling on multiple ends of the problem to get done. I recommend not to sweat it and focus on more pressing issues, namely those large areas that are not properly documented at all.
16:24:16
@fricklerhandwerk:matrix.orgfricklerhandwerk Which is to say: nix-shell is well-understood at the surface and has enough reference documentation to get quite far. The sharp edges and thorny problems are somewhere else. 16:26:57
@fractivore:cyberia.clubSYMYƧMaybe, but also keep in mind that I came to this diagram through an organic process of reading through the doc as a learner and reflecting on what wasn't quite clear to me. 16:35:58
@fractivore:cyberia.clubSYMYƧLooking over everything I could find on my own about nix-shell, in fact16:36:30
@fractivore:cyberia.clubSYMYƧOf course, everybody follows a unique learning process and gets hung up on different details, owing to their diverse backgrounds.16:39:49

Show newer messages


Back to Room ListRoom Version: 6