!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
10 Nov 2023
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @Minijackson:matrix.org
wasn't there some efforts recently for adding vale to nix.dev? There's a lint for that
indeed there is https://vale.sh/docs/topics/styles/#capitalization. we should add vale
15:12:51
@proofconstruction:matrix.orgproofconstruction it would be great to be able to declare the style guide, and have that automatically checked (and ideally auto-corrected) everywhere 15:38:37
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @proofconstruction:matrix.org
it would be great to be able to declare the style guide, and have that automatically checked (and ideally auto-corrected) everywhere
wdym? isn't a vale config file a declaration of (parts of) the style guide?
16:03:22
@proofconstruction:matrix.orgproofconstructionyes, I'm saying I support adding it16:04:04
@proofconstruction:matrix.orgproofconstructionrereading my previous message I can see that isn't at all clear. oops16:04:45
@proofconstruction:matrix.orgproofconstructionwhat I didn't see is whether vale has a mechanism for automatic remediation, or if it "just" surfaces noncompliance16:05:13
@j-k:matrix.orgj-kI don't think so...16:13:23
@j-k:matrix.orgj-kimage.png
Download image.png
16:13:27
@j-k:matrix.orgj-kyeah vale is just a linter with no autofixes16:14:52
@asymmetric:matrix.dapp.org.ukasymmetricI meant on the s vs z spelling16:17:51
@proofconstruction:matrix.orgproofconstructionif only we had a language for high-powered string interpolation16:18:05
@asymmetric:matrix.dapp.org.ukasymmetrichttps://en.wikipedia.org/wiki/Oxford_spelling16:18:27
11 Nov 2023
@ninjatrappeur:alternativebit.fr@ninjatrappeur:alternativebit.fr left the room.07:14:26
12 Nov 2023
@lehmanator:gnulinux.club@lehmanator:gnulinux.club joined the room.12:02:42
@toonn:matrix.orgtoonn changed their profile picture.17:53:46
13 Nov 2023
@asymmetric:matrix.dapp.org.ukasymmetric fricklerhandwerk: alejandrosame btw it looks like the "missing NIX_PATH" problem I was having after moving back to nix-shell is not happening just to me: https://github.com/NixOS/nix.dev/actions/runs/6850230882/job/18623992154?pr=798#step:4:1 12:55:01
@asymmetric:matrix.dapp.org.ukasymmetric * fricklerhandwerk: alejandrosame btw it looks like the "missing NIX_PATH" problem I was having after nix.dev was moved to nix-shell --run is not happening just to me: https://github.com/NixOS/nix.dev/actions/runs/6850230882/job/18623992154?pr=798#step:4:1 12:55:20
@asymmetric:matrix.dapp.org.ukasymmetric I personally always have to invoke nix-shell -I nixpkgs= ... 12:55:39
@asymmetric:matrix.dapp.org.ukasymmetric

even though

❯ echo $NIX_PATH
nixpkgs=/nix/store/sd0xal2sd16vwgpba0z7cwr6zylp3axk-z6w242l49pbrdawkz5vdhfxh2mvsj36c-source
12:56:21
@asymmetric:matrix.dapp.org.ukasymmetric maybe we need to tweak NIX_PATH when installing nix on the runner? 12:56:53
@fricklerhandwerk:matrix.orgfricklerhandwerkHere's the upstream issue: https://github.com/NixOS/nix/issues/889013:00:42
14 Nov 2023
@bzzm3r:matrix.org@bzzm3r:matrix.org left the room.09:36:36
@nbp:mozilla.orgnbp I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about NixOS are doing well" 10:33:36
@nbp:mozilla.orgnbp * I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well" 10:34:20
@j-k:matrix.orgj-kAh, Oxford University and Oxford University Press diverge on ize ise11:14:40
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @nbp:mozilla.org
I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well"

That video seems to be about NixOS, in which case that statement is a fair assessment. NixOS documentation is certainly not in a good shape and essentially unmaintained content-wise.

Nixpkgs has a huge surface and we can barely scratch that with available capacity, but it’s very slowly getting better. There are also a lot of infrastructure issues, going deep down into the code.

Nix itself is much more manageable in terms of system size and complexity, so progress is more visible there. But there are the same kind of structural problems that really need to be addressed at the code level to unblock sweeping improvements documentation.

14:01:20
@fricklerhandwerk:matrix.orgfricklerhandwerkEveryone is invited to take some ownership! The documentation team will gladly help anyone interested to get into the subject. We have meetings twice a week to ask questions, get some hand-holding, and discuss proposals and changes.14:02:50
@bzzm3r:matrix.org@bzzm3r:matrix.org joined the room.18:39:14
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @nbp:mozilla.org
I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well"

except most community-based information of this sort is either:

  1. wrong

  2. propagating unhelpful practices

  3. more of the "first we copy this" "then we paste this" variety

18:40:17
@bzzm3r:matrix.org@bzzm3r:matrix.orgso its really easy to end up wasting time on a resource, until someone who knows better corrects you18:40:41

Show newer messages


Back to Room ListRoom Version: 6