!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
3 Nov 2023
@aos1:matrix.orgaos joined the room.04:33:25
@asymmetric:matrix.dapp.org.ukasymmetric infinisil: can you mark https://github.com/NixOS/nix.dev/pull/645 as ready to review? 08:55:21
@asymmetric:matrix.dapp.org.ukasymmetricit 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
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

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.

See [`lib.lists.foldl'`](#function-library-lib.lists.foldl-prime) but for attribute sets.

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
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

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.

See [`lib.lists.foldl'`](#function-library-lib.lists.foldl-prime) but for attribute sets.

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
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

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.

See [`lib.lists.foldl'`](#function-library-lib.lists.foldl-prime) but for attribute sets.

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.
Is there some (un)/official guide for placing references?

09:04:55
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostThe only thing i found is https://github.com/NixOS/nixpkgs/blob/master/doc/README.md But it doesn't explain how to use references09:08:07
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * 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 functions09:08:17
@infinisil:matrix.orginfinisil 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
@infinisil:matrix.orginfinisilI generally inspect the web elements to find them09:13:29
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @infinisil:matrix.org
I generally inspect the web elements to find them

And now we depend on a certain web-elements beeing present on the same page ^^.
I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?

idea:

Something like
see [lib.lists.foldl]

Without any further. The rendering framework can transform this into references for achor tags, if it uses them.
I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.

09:17:13
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @infinisil:matrix.org
I generally inspect the web elements to find them
*

And now we depend on a certain web-elements beeing present on the same page ^^.
I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?

idea:

Something like
see [lib.lists.foldl']

Without any further. The rendering framework can transform this into references for achor tags, if it uses them.
I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.

09:17:39

Show newer messages


Back to Room ListRoom Version: 6