Nix Documentation | 438 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 91 Servers |
| Sender | Message | Time |
|---|---|---|
| 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 | |
| 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 | |