!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

417 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
20 Apr 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @djacu:matrix.org

olaf: You might be interested in what I was proposing for the module tutorials update. It's probably not as comprehensive as what you have in mind but might be suitable for smaller tests that don't need the infrastructure of a full nixos-test.

For my workshop, I created lessons where the code was separate from the markdown and inserted at build time of the site. Each example was evaluated/built and the result was also injected into the markdown. Essentially creating a system where the site would not build if the examples failed to evaluate. I didn't do any checking to make sure the answer was correct but that could be added.

The way I did this was pretty hacky and sometimes cursed (and definitely not the way we should do it on nix.dev) but it's what I had to do given my time constraints. With more time I would have needed to run Nix inside of Nix or come up with some other solution.

That's pretty much the idea in my sketch, except no hacky insertions into markdown, but rendering markdown from literate programs.
17:37:58
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @djacu:matrix.org

olaf: You might be interested in what I was proposing for the module tutorials update. It's probably not as comprehensive as what you have in mind but might be suitable for smaller tests that don't need the infrastructure of a full nixos-test.

For my workshop, I created lessons where the code was separate from the markdown and inserted at build time of the site. Each example was evaluated/built and the result was also injected into the markdown. Essentially creating a system where the site would not build if the examples failed to evaluate. I didn't do any checking to make sure the answer was correct but that could be added.

The way I did this was pretty hacky and sometimes cursed (and definitely not the way we should do it on nix.dev) but it's what I had to do given my time constraints. With more time I would have needed to run Nix inside of Nix or come up with some other solution.

* That's pretty much the idea in my sketch, except no hacky insertions into markdown, but rendering markdown (or anything) from literate programs.
17:38:10
@djacu:matrix.orgdjacuSeparate files is definitely hacky but worked for me. I had some copy scripts that would build the site and copy the resulting markdown into the live editing area. So I had a pseudo live editing experience. The real big upside to having separate code files is that all the lessons have files that is available to the reader to use right away. Although I wonder if it would be possible to write the code in the markdown, evaluate it (like we are talking about), and also extract it into files so the reader could use them.18:22:14
21 Apr 2024
@paperdigits:matrix.org@paperdigits:matrix.org joined the room.06:49:52
@me:indeednotjames.com@me:indeednotjames.comhttps://github.com/NixOS/nixpkgs/pull/305767: nixos/manual: abort build on warn15:18:24
@me:indeednotjames.com@me:indeednotjames.com PR has been updated and takes the existing documentation.nixos.options.warningsAreErrors option into account instead of hard-coding NIX_ABORT_ON_EVAL 16:21:35
@symys:fnord.theinfinitycorporation.comSYMYƧ joined the room.16:26:16
@symys:fnord.theinfinitycorporation.comSYMYƧHey I noticed a style issue with nix.dev ... the hyperlink color (when not highlighted) is the same color as the blue in-depth explanation expandable backgrounds.16:27:36
@symys:fnord.theinfinitycorporation.comSYMYƧIs that the kinda thing I should open an issue about? I am willing to help with it and all16:28:21
@symys:fnord.theinfinitycorporation.comSYMYƧ(I didn't open an issue, yet, because that seemed like a lot of overhead for such a minor change)16:29:26
@paperdigits:matrix.org@paperdigits:matrix.org left the room.16:57:38
@infinisil:matrix.orginfinisil
In reply to @symys:fnord.theinfinitycorporation.com
Hey I noticed a style issue with nix.dev ... the hyperlink color (when not highlighted) is the same color as the blue in-depth explanation expandable backgrounds.
Oh neat find, apparently it only happens in the light theme, which is why I haven't seen in before.

If you can fix it yourself, a PR would be best!
20:06:52
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @symys:fnord.theinfinitycorporation.com
Hey I noticed a style issue with nix.dev ... the hyperlink color (when not highlighted) is the same color as the blue in-depth explanation expandable backgrounds.
I can have a look as it's caused by my pr
20:22:21
@olafklingt:matrix.org@olafklingt:matrix.orgI self merged this time because it would be a major annoyance when one cannot read the tutorial properly. 21:30:33
@symys:fnord.theinfinitycorporation.comSYMYƧ
In reply to @olafklingt:matrix.org
I can have a look as it's caused by my pr
Oh, thanks! Looks good, much easier to read and still in color scheme.
22:55:51
22 Apr 2024
@olafklingt:matrix.org@olafklingt:matrix.org fricklerhandwerk: this commit https://github.com/NixOS/nix.dev/pull/940/commits/b556495361e12a9e81adc8080e362ea032b1e123 reverts the change i made to find a middle ground between having the command in the text and removing it. is this on purpose? 16:46:40
@fricklerhandwerk:matrix.orgfricklerhandwerkThe NixOS admonition and the footnote were essentially the same thing, and the footnote requires jumping around. Or did we miss something? I’ll fix up the breakage of course16:50:03
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @fricklerhandwerk:matrix.org
The NixOS admonition and the footnote were essentially the same thing, and the footnote requires jumping around. Or did we miss something? I’ll fix up the breakage of course
the jumping implied by a footnote highlights that its not part of the flow of argument. but keeping the reference helps to move between parts of the documentation.
16:53:20
@jonringer:matrix.orgjonringerPython Docs PR: https://github.com/NixOS/nixpkgs/pull/30611922:29:07
23 Apr 2024
@me:indeednotjames.com@me:indeednotjames.com left the room.16:48:19
24 Apr 2024
@stablejoy:matrix.org@stablejoy:matrix.org changed their profile picture.08:59:13
@koen:procolix.com@koen:procolix.com left the room.17:37:04
@stablejoy:matrix.org@stablejoy:matrix.org

I'm going through the packaging tutorial at https://nix.dev/tutorials/packaging-existing-software.html and evaluating the example skeleton derivation gives a error: syntax error, unexpected ';', expecting end of file. Is this a typo?

{ stdenv }:
stdenv.mkDerivation {	};

# shouldn't it be this instead
❯ nix-instantiate --eval --expr '{ stdenv }: stdenv.mkDerivation {}'
<LAMBDA>
19:10:05
@infinisil:matrix.orginfinisil stablejoy: Nice catch! Would you mind PRing that quick fix? 19:18:40
@stablejoy:matrix.org@stablejoy:matrix.org
In reply to @infinisil:matrix.org
stablejoy: Nice catch! Would you mind PRing that quick fix?
Yes Id love to thanks!
19:21:06
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostSorry guys was a bit busy last two weeks trying to shave some time off tomorrow for fixing nixdoc (again 😀).21:28:13
@infinisil:matrix.orginfinisil Johannes Kirschbauer @hsjobeki: No worries ;) 22:37:52
@stablejoy:matrix.org@stablejoy:matrix.orgaw I did the PR, it's my first ever, it's waiting to be merged. I cried. 22:47:54
@infinisil:matrix.orginfinisil stablejoy: Ah nice, didn't see it because it has a dedicated code owner that gets pinged (which overrides the default code owner of the entire team). Thanks, merging! 22:56:56
25 Apr 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk I won't make the meeting today. infinisil will you be in? 07:37:32

Show newer messages


Back to Room ListRoom Version: 6