Nix Documentation | 434 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 91 Servers |
| Sender | Message | Time |
|---|---|---|
| 3 Nov 2023 | ||
| 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 | |
| Johannes Kirschbauer @hsjobeki: I'm the main user of those. They're added by nixdoc. I'm using them because it's the only way to reference functions. | 09:12:35 | |
| I generally inspect the web elements to find them | 09:13:29 | |
In reply to @infinisil:matrix.org And now we depend on a certain web-elements beeing present on the same page ^^. idea: Something like Without any further. The rendering framework can transform this into references for achor tags, if it uses them. | 09:17:13 | |
In reply to @infinisil:matrix.org* And now we depend on a certain web-elements beeing present on the same page ^^. idea: Something like Without any further. The rendering framework can transform this into references for achor tags, if it uses them. | 09:17:39 | |
| That opens the box of pandora: context aware references ^^
š | 09:19:43 | |
| * That opens the box of pandora: context aware references ^^
š | 09:20:17 | |
| Some references refer to internal things, while some refer to external attributes. Just playing around with the idea š | 09:21:31 | |
| Can't run nix.dev devmode:
| 09:21:36 | |
| cc fricklerhandwerk alejandrosame | 09:22:33 | |
Whats in your $NIX_PATH, is it empty ? | 09:23:00 | |
In reply to @johannes.kirschbauer:scs.ems.hostnope, it has nixpkgs=/nix/store/... | 09:23:56 | |
| Johannes Kirschbauer @hsjobeki: We can freely change the source code (just needs some automated/manual work) though I guess the anchors should stay the same. I don't really care about the format as long as it works :) | 09:24:24 | |
In reply to @asymmetric:matrix.dapp.org.ukI think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :) | 14:53:20 | |
In reply to @johannes.kirschbauer:scs.ems.host We havenāt discussed this, but someone recently made me aware of https://github.com/stepchowfun/tagref I think itās a nice idea, and seems like it would scale better than the reference system Sphinx uses (which in its MyST incarnation canāt discern between file paths and references⦠it produces a lot of busywork). | 15:11:39 | |
In reply to @alejandrosame:matrix.orgIām not sure why there is a need for NIX_PATH to be set. Why and when did it even break? It worked a couple of days ago. | 15:13:28 | |
In reply to @fricklerhandwerk:matrix.orgWhere is NIX_PATH set? I don't follow. | 15:25:11 | |
| The error complains about NIX_PATH not containing nixpkgs | 15:33:13 | |
| Ah, I was talking about the error in the issue https://github.com/NixOS/nix.dev/issues/787 | 16:06:38 | |
| https://github.com/NixOS/nix.dev/pull/645#issuecomment-1792303015 | 17:40:13 | |
| Any comments on this one? | 17:40:18 | |
In reply to @fricklerhandwerk:matrix.orgIt could be something on my end. Or at least, I have the same problem with the old ./live script | 17:46:22 | |
| 19:50:59 | ||
| 4 Nov 2023 | ||
| 14:32:26 | ||