!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

434 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

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


SenderMessageTime
3 Nov 2023
@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
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

That opens the box of pandora: context aware references ^^

{
   /**
   # Params

  - [a] A number
  - [b] Another number

   */
   lib.foo = a: b: a +b;
}

😃

09:19:43
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

That opens the box of pandora: context aware references ^^

{
   /**
   See also [lib.trivial.add]
   # Params

  - [a] A number
  - [b] Another number

   */
   lib.foo = a: b: a +b;
}

😃

09:20:17
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostSome references refer to internal things, while some refer to external attributes. Just playing around with the idea 😃09:21:31
@asymmetric:matrix.dapp.org.ukasymmetric

Can't run nix.dev devmode:

āÆ nix-shell --run devmode
error:
       … while calling the 'import' builtin

         at «string»:1:2:

            1| (import <nixpkgs> {}).bashInteractive
             |  ^

       … while calling the 'findFile' builtin

         at «string»:1:9:

            1| (import <nixpkgs> {}).bashInteractive
             |         ^

       error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)

       at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
09:21:36
@asymmetric:matrix.dapp.org.ukasymmetric cc fricklerhandwerk alejandrosame 09:22:33
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host Whats in your $NIX_PATH, is it empty ? 09:23:00
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @johannes.kirschbauer:scs.ems.host
Whats in your $NIX_PATH, is it empty ?
nope, it has nixpkgs=/nix/store/...
09:23:56
@infinisil:matrix.orginfinisil 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
@alejandrosame:matrix.orgalejandrosame
In reply to @asymmetric:matrix.dapp.org.uk

Can't run nix.dev devmode:

āÆ nix-shell --run devmode
error:
       … while calling the 'import' builtin

         at «string»:1:2:

            1| (import <nixpkgs> {}).bashInteractive
             |  ^

       … while calling the 'findFile' builtin

         at «string»:1:9:

            1| (import <nixpkgs> {}).bashInteractive
             |         ^

       error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)

       at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :)
14:53:20
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @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.

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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @alejandrosame:matrix.org
I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :)
I’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
@alejandrosame:matrix.orgalejandrosame
In reply to @fricklerhandwerk:matrix.org
I’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.
Where is NIX_PATH set? I don't follow.
15:25:11
@fricklerhandwerk:matrix.orgfricklerhandwerkThe error complains about NIX_PATH not containing nixpkgs15:33:13
@alejandrosame:matrix.orgalejandrosameAh, I was talking about the error in the issue https://github.com/NixOS/nix.dev/issues/78716:06:38
@asymmetric:matrix.dapp.org.ukasymmetrichttps://github.com/NixOS/nix.dev/pull/645#issuecomment-179230301517:40:13

Show newer messages


Back to Room ListRoom Version: 6