Nix Documentation | 425 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 86 Servers |
| Sender | Message | Time |
|---|---|---|
| 16 Mar 2024 | ||
| in any case it would be easy to split the manual as is, and with just a little work the split could be done programmatically based on toc structure too. that's part of why the toc data structures are the way they are | 18:59:12 | |
| (we haven't read much of the backlog past seeing that the question must've existed because that part was full of build logs, and the backlog didn't go much further anyway. gotta love matrix) | 19:00:38 | |
| Do you have the issue number? can't find it on the project board. | 19:02:29 | |
| issue number for what? | 19:02:54 | |
| I assumed we had an issue for page splitting. Might not be true then? | 20:52:54 | |
| ah. can't remember one immediately at least | 20:53:50 | |
| yeah, there isn't one we could find either | 20:57:09 | |
| There's some top-level attribute Ideas? | 21:53:40 | |
| * There's some top-level attribute Ideas? | 21:53:58 | |
| set by the flake machinery because it's a git repo, probably | 21:54:42 | |
In reply to @pennae:matrix.eno.space Hm no, at least I don't see how a flake would do that. An empty flake like this:
called with | 21:59:30 | |
In reply to @pennae:matrix.eno.space* Hm no, at least I don't see how a flake would do that. An empty flake in a Git repo, like this:
called with | 21:59:58 | |
| commit it | 22:03:24 | |
| I did | 22:03:31 | |
| shows up having a rev for us | 22:03:47 | |
| Ah okay, apparently something was weird when using an existing repo. It worked in a clean one. | 22:04:23 | |
| Thanks. Cursed stuff. | 22:06:21 | |
| that's flakes for you | 22:06:28 | |
https://www.catb.org/esr/writings/unix-koans/ten-thousand.html | 22:08:32 | |
| 17 Mar 2024 | ||
In reply to @fricklerhandwerk:matrix.orgindeed, the wiki is useful but I also find it goes into too much detail with flag setting. most of the time, if you set up things correctly, it should "just work". maybe I can add a section here in the meantime | 01:00:37 | |
In reply to @fricklerhandwerk:matrix.orgthat is good to see! I was actually thinking about the writers that live under scripts.nix (confusingly named indeed). these let you write python and many other languages inline and are, afaict not in the manual at all | 01:02:20 | |
| there is an aged issue about it: https://github.com/NixOS/nixpkgs/issues/89759 | 01:03:11 | |
| there is documentation in the source, so maybe it's an issue of making them render in the manual? not sure | 01:06:41 | |
In reply to @rina/:matrix.orgYeah it probably just needs to be wired up | 03:16:31 | |
In reply to @rina/:matrix.orgIf you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways in the long term. I remembered that the writers because some of them are dynamically created by partial application | 15:44:08 | |
In reply to @rina/:matrix.org* If you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways in the long term. I remembered that the writers because some of them are dynamically created by partial application and callPackages (plural s) | 15:44:33 | |
| * If you could give a concrete example i can tell you if its a wiring issue or would need to be maintained seperately anyways. I remembered that the writers have some difficulties. Because some of them are dynamically created by partial application and mapped via callPackages (plural s). | 15:48:12 | |
| Depends which methods we use for wiring them up. | 15:54:02 | |
| I am also not sure when it was decided to move reference documentation out of the source it is related to. I think this is a mistake. https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/trivial-builders/default.nix We still have nixdoc to retrieve doc-comments and it was extended recently. So wiring should only be a question of adding more files to the index. | 16:00:33 | |
| Expanding it should be question of adding more include blocks like this: https://github.com/NixOS/nixpkgs/blob/178fc9602881340bd8c02c0f9b64c25aedc0eb53/doc/doc-support/lib-function-docs.nix#L32C1-L39C34 | 16:01:45 | |