!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

430 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
18 Sep 2024
@viperml:ayats.org@viperml:ayats.org hello again, I believe pkgs.writers are not documented in the nixpkgs manual 🤔 13:02:52
23 Sep 2024
@phanirithvij:matrix.orgphanirithvij nix-build --check flag is not documented in nix manual https://nix.dev/manual/nix/latest/command-ref/nix-build.html 09:05:30
@phanirithvij:matrix.orgphanirithvijit is refrenced here https://nix.dev/manual/nix/latest/advanced-topics/diff-hook#spot-checking-build-determinism09:06:41
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
nix-build --check flag is not documented in nix manual https://nix.dev/manual/nix/latest/command-ref/nix-build.html
Thanks for the pointer. Please open an issue on GitHub so we don't lose track of it
09:27:52
@phanirithvij:matrix.orgphanirithvijok I will check if any existing issues exist or create one09:29:48
@phanirithvij:matrix.orgphanirithvijRedacted or Malformed Event09:31:16
@phanirithvij:matrix.orgphanirithvij * seems there is one already by you, https://github.com/NixOS/nix/issues/798109:31:30
@phanirithvij:matrix.orgphanirithvij
In reply to @fricklerhandwerk:matrix.org
Thanks for the pointer. Please open an issue on GitHub so we don't lose track of it
seems there is one already by you, https://github.com/NixOS/nix/issues/7981
09:33:06
@fricklerhandwerk:matrix.orgfricklerhandwerkAh thanks, I didn't find it on a quick skim09:34:42
@phanirithvij:matrix.orgphanirithvijwhat is the current ongoing documentation effort, I mean what is being worked on? where can I follow it?09:39:22
@phanirithvij:matrix.orgphanirithvijok I found what has been done recently https://discourse.nixos.org/search?q=This%20Month%20in%20Nix%20Docs%20in%3Atitle%20order%3Alatest_topic09:49:36
@phanirithvij:matrix.orgphanirithvijalso https://github.com/orgs/NixOS/projects/15/views/114:09:44
@elikoga:matrix.orgelikoga joined the room.15:30:54
@connorbaker:matrix.orgconnor (burnt/out) (UTC-8) changed their display name from connor (he/him) (UTC-5) to connor (he/him) (UTC-7).17:57:39
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
what is the current ongoing documentation effort, I mean what is being worked on? where can I follow it?
It’s been a bit quiet around the team recently, and the project board is out of date. There are a few isolated efforts here and there, and I keep reviewing PRs. Any help is greatly appreciated - if you want to pick up or start something, we can supply all the information you need to get going
18:59:37
@phanirithvij:matrix.orgphanirithvij
In reply to @fricklerhandwerk:matrix.org
It’s been a bit quiet around the team recently, and the project board is out of date. There are a few isolated efforts here and there, and I keep reviewing PRs. Any help is greatly appreciated - if you want to pick up or start something, we can supply all the information you need to get going
I've added a broken link checker github workflow to nixos wiki infra recently and plan to do something similar to find broken/outdated links in nixpkgs as a maintainer script.
20:38:42
@phanirithvij:matrix.orgphanirithvijlet me know if there is something similar already, I couldn't find it in my brief search20:39:45
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
I've added a broken link checker github workflow to nixos wiki infra recently and plan to do something similar to find broken/outdated links in nixpkgs as a maintainer script.
In the Nixpkgs and NixOS manuals, internal references are already checked. You could run lychee impurely to check external links though
20:40:55
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
I've added a broken link checker github workflow to nixos wiki infra recently and plan to do something similar to find broken/outdated links in nixpkgs as a maintainer script.
* In the Nixpkgs and NixOS manuals, internal references are already checked by the rendering engine. You could run lychee impurely to check external links though
20:41:05
@phanirithvij:matrix.orgphanirithvij yes, external links in manuals is what I was thinking, also checking meta.homepage meta.changelog if possible for all packages 20:42:12
@fricklerhandwerk:matrix.orgfricklerhandwerk

The Nix manual could need help with internal references though:

  • https://github.com/NixOS/nix/issues/10313
  • https://github.com/NixOS/nix/pull/11306
20:43:26
@phanirithvij:matrix.orgphanirithvij oh, I could've searched for lychee in issues, didn't realise it. I will look at those. 20:44:38
@phanirithvij:matrix.orgphanirithvijalso do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense?20:45:52
@phanirithvij:matrix.orgphanirithvijsince hydra will build almost all nixpkgs so those packages will fail right?20:46:37
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
also do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense?
in principle, but we have to be careful to rate limit that very tightly. it shouldn't run on every hydra job but more like once a month at most
20:46:56
@fricklerhandwerk:matrix.orgfricklerhandwerkand it shouldn't be a blocker for anything20:47:29
@fricklerhandwerk:matrix.orgfricklerhandwerkWhat we could and should do is run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:28
@fricklerhandwerk:matrix.orgfricklerhandwerk * What we could and should do is unconditionally run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:35
@fricklerhandwerk:matrix.orgfricklerhandwerk * What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:43
@fricklerhandwerk:matrix.orgfricklerhandwerk(but probably also not every single time)20:49:09

Show newer messages


Back to Room ListRoom Version: 6