Nix Documentation | 438 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 91 Servers |
| Sender | Message | Time |
|---|---|---|
| 30 Oct 2023 | ||
| 17:04:19 | ||
| 19:51:24 | ||
| 31 Oct 2023 | ||
| Someone else will need to do the This Month in Nix Docs from now on since I’m not as tuned in. It’s pretty easy with the script that I wrote. | 00:29:44 | |
| https://github.com/NixOS/nixos-homepage/pull/1141 | 13:50:49 | |
| I said I'd do this so I did but I didn't bother explaining much in the PR body. | 13:51:33 | |
| 1 Nov 2023 | ||
| 11:04:33 | ||
| asymmetric: Could you make a new nixdoc release? | 20:51:32 | |
| 2 Nov 2023 | ||
In reply to @infinisil:matrix.orgyep, will do, later today | 08:12:33 | |
| I'm gonna have to skip today's meeting. Compulsory meeting in meat-space. Cheers! | 11:55:03 | |
| 13:28:40 | ||
| 13:29:18 | ||
In reply to @infinisil:matrix.orghttps://github.com/nix-community/nixdoc/releases/tag/v2.5.1 | 14:38:55 | |
| 16:56:32 | ||
A co worker of mine recently installed NixOS for the first time and when looking for something like how to install nixos the wiki shows up first and has a more fitting name since it shows up as "NixOS Installation Guide" and the offical manual guide shows up as "NixOS 23.05 manual | Nix & NixOS" which confused him since if it's the first time you doing anything nix related you don't know that the wiki is user maintained and unoffical and that many articals are chronically outdated. And I'm unsure what to do about it since clearly some people think that a article like that should exist in the wiki. | 17:10:09 | |
| I've noticed this shift of people's assumption about what a wiki is too. Its origin is definitely communally edited articles. Nixos.org does point to the manual. Not sure how to influence search results. | 17:14:05 | |
* A coworker of mine recently installed NixOS for the first time and when looking for something like how to install nixos the wiki shows up first and has a more fitting name since it shows up as "NixOS Installation Guide" and the offical manual guide shows up as "NixOS 23.05 manual | Nix & NixOS" which confused him since if it's the first time you doing anything nix related you don't know that the wiki is user maintained and unoffical and that many articals are chronically outdated. And I'm unsure what to do about it since clearly some people think that a article like that should exist in the wiki. | 17:17:18 | |
| We'll improve search results by breaking down the manuals into smaller pages so they are more likely to get fully indexed by search engines, and by adding more relevant metadata. The first step is probably not super hard to do, just needs some concentration. It has something to do with the | 19:26:55 | |
| * We'll improve search results by breaking down the manuals into smaller pages so they are more likely to get fully indexed by search engines, and by adding more relevant metadata. The first step is probably not super hard to do with a Python background, just needs some concentration. It has something to do with the | 19:27:31 | |
| And well, the rest requires Someone™ to take time and curate the NixOS manuals. The docs team is currently fully busy with the Nix manual, nix.dev, and tiny slices of the Nixpkgs manual. | 19:29:03 | |
| ugh FYI: nix.dev is currently semi-borked because we're moving the DNS provider from cloudflare to netlify, and that's causing issues with provisioning the TLS certificate for the website. I'm monitoring, hoping it fixes itself in the next few minutes. | 19:48:05 | |
| ah great, it's resolved already, afaict | 19:48:29 | |
| so let it be known there were possibly errors for ~5-10min | 19:48:49 | |
| 3 Nov 2023 | ||
| 04:33:25 | ||
| infinisil: can you mark https://github.com/NixOS/nix.dev/pull/645 as ready to review? | 08:55:21 | |
| it seems i don't have perms to do it myself, which would be handy. i can edit the content of the first post, for example. | 08:56:46 | |
| It might be personal thing... I don't like those achor tags in our nix code because strictly bind our lib documentation to the current manual rendering, with those exact achor tags. Changing something in rendering (e.g. splitting in multiple pages) now means also breaking the documentation.
Has this been discussed in the documentation team? I'd prefer to keep the actual content un-opinionated from our rendering framework, and place neutral references, that are autoresolved instead of hard links, which break when touching the thing. | 09:03:24 | |
| * I don't like those achor tags in our nix code because strictly bind our lib documentation to the current manual rendering, with those exact achor tags. Changing something in rendering (e.g. splitting in multiple pages) now means also breaking the documentation.
Has this been discussed in the documentation team? I'd prefer to keep the actual content un-opinionated from our rendering framework, and place neutral references, that are autoresolved instead of hard links, which break when touching the thing. | 09:03:34 | |
| * I don't like those achor tags in our nix code because strictly bind our lib documentation to the current manual rendering, with those exact achor tags. Changing something in rendering (e.g. splitting in multiple pages) now means also breaking the documentation.
Has this been discussed in the documentation team? I'd prefer to keep the actual content un-opinionated from our rendering framework, and place neutral references, that are autoresolved instead of hard links, which break when touching the thing. | 09:04:55 | |
| The only thing i found is https://github.com/NixOS/nixpkgs/blob/master/doc/README.md But it doesn't explain how to use references | 09:08:07 | |
| * The only thing i found is https://github.com/NixOS/nixpkgs/blob/master/doc/README.md But it doesn't explain how to use references to other lib functions | 09:08:17 | |