Nix Documentation | 395 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 80 Servers |
| Sender | Message | Time |
|---|---|---|
| 6 Jul 2024 | ||
| Each of those things has a reference manual, all of them linked in nix.dev. The reference manuals are supposed to only show what’s there, with a few examples, while nix.dev is for tutorials and guides. The separation is not as clean in reality, because there are a lot of pieces to the puzzle, and the time people spent so far was not enough to untangle everything. Home Manager is unfortunately not listed there yet, and the only reason is that no one got to explain, within the narrative arc we’re building, which role it plays and how to start out. | 10:17:26 | |
| There's the official, actively maintained NixOS wiki at wiki.nixos.org. Together with the NixOS reference manual is where most NixOS documentation lives. But it's very thin altogether, so it should be easy to add useful things as you find them. | 10:23:28 | |
| NixOS documentation does not have all that many helping hands, and the user-facing tools are not in great shape, in my opinion. So there are still endless misconceptions implanted into beginners' minds. If you have the time to dig into it and read the source code, I'm there to answer any questions you may encounter, or point you to better places where to ask them. | 10:25:31 | |
| As for flakes, here's an overview: https://nix.dev/concepts/flakes | 10:26:18 | |
| The Nix manual's glossary is only about Nix concepts. Modules, options, packages are Nixpkgs things, but the Nixpkgs manual doesn't have a glossary yet - I'd help getting a first attempt merged! Home Manager has its own documentation (without a glossary): https://nix-community.github.io/home-manager/ | 10:28:53 | |
| As for overall structure and discoverability.. yes, that's still an issue. Many people come to the ecosystem through NixOS, but there's really no one maintaining the user experience there. I've been taking things from the bottom up for the past two years, guiding people who start with Nix on an existing system, and I think things have improved. But NixOS just has very different requirements, and one needs to think it through and find a place where people can go through that journey. These things are up for grabs, so if you really want to change that and show up consistently, you can take the lead on that. | 10:32:40 | |
| Thanks for the very good explanation :) | 13:23:44 | |
| 7 Jul 2024 | ||
| 21:20:38 | ||
| 8 Jul 2024 | ||
| 06:00:24 | ||
| 06:00:33 | ||
| 19:20:17 | ||
| 9 Jul 2024 | ||
| 04:59:30 | ||
| 10 Jul 2024 | ||
In reply to @proofconstruction:matrix.orgIt never fails to surprise me how time flies. This comment is also an attempt to understand how badly I'll spam the main channel when I comment in this thread... | 21:34:57 | |
| Download nix-docs-proposal.md | 21:37:41 | |
In reply to @enn_:matrix.orgclearly in no particular rush from my side 😅 I've attached a brief proposal relating to nix docs for consideration. Am happy to come along to an office hours session if that is useful / appropriate, or just receive feedback here, whatever works 🙂 | 21:39:27 | |
| 23:02:34 | ||
| 11 Jul 2024 | ||
| 10:53:04 | ||
| 17:11:22 | ||
| 15 Jul 2024 | ||
| I was trying to try to help out in the nix.dev repo by going through old issues and seeing if any can be closed or easily fixed. Should I ping someone from the issue if I think it can be closed or just leave a comment or something? | 00:23:44 | |
| Redacted or Malformed Event | 01:38:24 | |
| * I was thinking to try to help out in the nix.dev repo by going through old issues and seeing if any can be closed or easily fixed. Should I ping someone from the issue if I think it can be closed or just leave a comment or something? | 02:14:13 | |
| Download issues.md | 05:58:11 | |