Nix Documentation | 435 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 90 Servers |
| Sender | Message | Time |
|---|---|---|
| 15 Oct 2023 | ||
| as a matter of fact, when I ls the path, there is no executable there... What am I missing? | 07:44:29 | |
Als Antwort auf @fricklerhandwerk:matrix.orgThanks. I think reference documentation must be complete first. Then wie can add opinionated help/practices like: „dont use Builtins in nixpkgs because…“ Not having the documentation in one place is not enjoyable for most users. Most of the time you just need to get it work first then you learn about how to do it the (maybe opinionated) right way. | 07:45:39 | |
| hey there! Note that this channel is not a general help channel, unless it's about the documentation itself | 07:46:34 | |
| Sorry, I've just noticed I am writing on the wrong channel. | 07:46:48 | |
but for your error, I think it comes from $/out/bin which needs to be $out/bin | 07:47:03 | |
| and by reference documentation i mean „dumb“ and Objektive explanation how to call a function. And Not how to use it the right way. We should try to seperate opinionated Tutorials/Exemplar and un-opinionated api descriptions | 07:49:51 | |
| * and by reference documentation i mean „dumb“ and Objektive explanation how to call a function. And Not how to use it the right way. We should try to seperate opinionated Tutorials/examples and un-opinionated api descriptions | 07:50:20 | |
| 22:02:17 | ||
| I have a long post of feedback which tbf is mostly probably stuff we already know, sourced from a friend. Is this the right place to put it or should it go on discourse? | 22:03:48 | |
| * I have a long post of feedback which tbf is mostly probably stuff we already know, sourced from a friend who just learned NixOS. Is this the right place to put it or should it go on discourse? | 22:04:00 | |
(jade): it sucks that our manual is incredibly anti seo because the fact that it's one massive page is incredibly nice to ctrl f and not have to trust some terrible in-page search engine. but the upgrade ryantm is doing would help here i think.
(jade): especially it's hard to find it in the nix manual and we're doing no favours by having our manuals all separated so that you can't search in one to find things in the other. global search across nix.dev, nix, nixpkgs, and nixos docs would be good maybe?
| 22:09:55 | |
| 17 Oct 2023 | ||
| I'm planning to merge this in one week unless I get feedback about it. https://github.com/NixOS/nixpkgs/pull/108063/files it's a fairly self contained change. | 13:20:48 | |
In reply to @ryantm:matrix.orgDoesn't seem that it's been linked to from https://github.com/NixOS/nixpkgs/issues/156309 It's not mdbook but it's about creating a paged docs | 16:49:24 | |
| 19 Oct 2023 | ||
| I'm likely not going to make it to the meeting today. If there is anything anyone really needs to discuss or review or get merged today, please ping me and I will try to arrange it regardless. | 08:14:57 | |
| Today me and henrik-ch started curating the doc team member list: https://discourse.nixos.org/t/2023-10-19-documentation-team-meeting-notes-87/34349 | 14:55:27 | |
| henrik-ch: See the edit history of the meeting notes, did minor updates | 14:58:14 | |
| 20 Oct 2023 | ||
| I finally have a PR up for sphinxext-rediraffe: https://github.com/NixOS/nixpkgs/pull/262182 | 04:38:16 | |
| 10:34:34 | ||
hey so the docs for fixed-output derivations don't have any direct mention of the fact they enable network access? only implications with the fetchurl example? | 19:33:33 | |
| and that regular derivations don't, at least when the sandbox is enabled which I think is basically always? | 19:35:38 | |
| 21 Oct 2023 | ||
In reply to @ckie:ckie.devYes, apparently. Would you mind adding a sentence that mentions this? | 09:52:09 | |
| If you need some guidance to make the change, check this new page: https://nixos.org/manual/nix/unstable/contributing/documentation It likely won’t cover everything you need, and I’d be happy about feedback on how to improve it | 09:53:30 | |
| Is the team aware of this PR: https://github.com/NixOS/nixpkgs/pull/108063? | 14:10:41 | |
| Have been very busy but will be able to review some stuff this weekend | 14:32:26 | |
In reply to @alejandrosame:matrix.orgAware but have no opinion about it. | 16:20:40 | |
| 22 Oct 2023 | ||
In reply to @alejandrosame:matrix.orgI am aware of it - was looking at it at nixcon with ryantm . | 11:29:45 | |
| is there a reason why for the module system, we say "defining an option" instead of "setting an option"? I feel like i have to think a couple seconds every time i read definition/declaration, to remember what each means. this wouldn't happen with setting/declaration | 15:21:40 | |
| 19:44:10 | ||
| 23 Oct 2023 | ||
In reply to @asymmetric:matrix.dapp.org.uk Robert Hensing (roberth) wrote a proposal on changing that: https://github.com/NixOS/nixpkgs/issues/185234 I think it should be implemented as written. There's a pile of issues on module system docs, this is one of it. | 09:41:45 | |
In reply to @asymmetric:matrix.dapp.org.uk* Robert Hensing (roberth) wrote a proposal on changing that: https://github.com/NixOS/nixpkgs/issues/185234 I think it should be implemented as written. There's a pile of issues with the module system docs, this is one of it. | 09:42:05 | |