!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

396 Members
Discussion about documentation improvements around the Nix ecosystem81 Servers

Load older messages


SenderMessageTime
12 Jun 2024
@lorenzleutgeb:matrix.orgLorenz Leutgeb removed their display name Lorenz Leutgeb.00:31:17
@lorenzleutgeb:matrix.orgLorenz Leutgeb set their display name to Lorenz Leutgeb.00:32:51
15 Jun 2024
@getpsyched:matrix.orggetpsyched I was wondering what's the status of PR review material in nixpkgs. So far, I've seen some points put in nixos/README.md and pkgs/README.md for reviewing contributions. Are there any other "official" or community efforts on this? 12:04:37
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @getpsyched:matrix.org
I was wondering what's the status of PR review material in nixpkgs. So far, I've seen some points put in nixos/README.md and pkgs/README.md for reviewing contributions. Are there any other "official" or community efforts on this?
These are the only places, to my knowledge.
14:29:07
@getpsyched:matrix.orggetpsychedHmm. It might be worthwhile making a single resource where all of these things are combined as a comprehensive guide. I'm willing to take this on sometime soon. Wondering what would be a good place to put it; Maybe a dedicated project or, better yet, a wiki page 🤔 14:31:59
@getpsyched:matrix.orggetpsyched * Hmm. It might be worthwhile making a single resource where all of these things are combined as a comprehensive guide. I'm willing to take this on sometime soon. Wondering what would be a good place to put it; Maybe a dedicated project or, better yet, a wiki page 🤔 14:32:06
@proofconstruction:matrix.orgproofconstructionDepends on what you mean by PR review materials, really. Guidelines for what to look for when reviewing? In any case, information scoped to a particular project should live in that project’s repo.20:47:06
16 Jun 2024
@getpsyched:matrix.orggetpsyched

In any case, information scoped to a particular project should live in that project’s repo.

Yeah I don't mean project-specific quirks.

Guidelines for what to look for when reviewing?

At the crux of it, yes. Most of the basic conventions are known by most people but a lot of the relatively "newer" things like not overusing pname, or any other quirks specific to helper functions et al.

06:27:13
17 Jun 2024
@infinisil:matrix.orginfinisil getpsyched: Check out https://github.com/NixOS/nixpkgs/pull/245243 15:36:00
@infinisil:matrix.orginfinisilI think it would be best to continue with the effort to clean up the contributor docs, there's still a lot of work to be done15:36:16
@infinisil:matrix.orginfinisil E.g. pkgs/README.md is rather messy 15:36:46
@infinisil:matrix.orginfinisilIt would also be great to render all of these markdown pages into a single HTML document that gets automatically updated for every master commit, e.g. using github pages15:38:27
@getpsyched:matrix.orggetpsychedThat sounds like a good idea.15:54:36
@getpsyched:matrix.orggetpsychedI'll skim over all the docs and see what's a better way to organise them, if not just a cleanup15:55:32
19 Jun 2024
@gas.station.sushi:matrix.orggas.station.sushi joined the room.00:16:18
20 Jun 2024
@fricklerhandwerk:matrix.orgfricklerhandwerkI can’t make the office hours today, sorry14:37:36
21 Jun 2024
@jade_:matrix.org@jade_:matrix.org left the room.05:15:35
@linus:schreibt.jetzt@linus:schreibt.jetzt left the room.14:05:43
@hexa:lossy.networkhexaRedacted or Malformed Event19:41:51
23 Jun 2024
@janne.hess:helsinki-systems.de@janne.hess:helsinki-systems.de left the room.15:30:40
@jordy:alkema.coJordy joined the room.15:50:49
24 Jun 2024
@dclmatrix:matrix.org@dclmatrix:matrix.org removed their profile picture.05:28:22
@dclmatrix:matrix.org@dclmatrix:matrix.org removed their display name blu3.05:28:28
@dclmatrix:matrix.org@dclmatrix:matrix.org left the room.05:28:33
@fricklerhandwerk:matrix.orgfricklerhandwerkI finally uploaded a little introductory video for working on the Nix manual: https://www.youtube.com/watch?v=8ogaUFuAkCY09:52:59
@fricklerhandwerk:matrix.orgfricklerhandwerkFeedback appreciated, also what else would be worth covering without too much effort09:53:25
@stefanwschroeder:matrix.orgStefan Schroeder
In reply to @fricklerhandwerk:matrix.org
Feedback appreciated, also what else would be worth covering without too much effort
This video is great. I wish there were more of this type. Improvement suggestion: Don't use your history to recall commands. Also, when using additional tools (like hub) tell your audience how to get them.
16:47:11
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @fricklerhandwerk:matrix.org
Feedback appreciated, also what else would be worth covering without too much effort

Maybe would be great to see how to change builtins/primop docs.
And what conventions to follow there roughly.

Or another thing: you didnt show how to refresh the manual in the browser really fast. If you change anything in a c file make is pretty slow and you have to wait 5 minutes for a typo fix to compile.

17:18:19
@fricklerhandwerk:matrix.orgfricklerhandwerk Thanks Stefan Schroeder Johannes Kirschbauer @hsjobeki, I'll take that into account when I get to recording the next thing 17:44:45
@philiptaron:matrix.orgPhilip Taron (UTC-8)Redacted or Malformed Event23:59:51

Show newer messages


Back to Room ListRoom Version: 6