infinisil: Roughly tracking the following relations:

1. Code <-> Documentation
2. Documenation <-> Documentation
3. Documentation -> external references. e.g. references from nixpkgs to nix manual

For each of those we should have some kind of solution.

fricklerhandwerk Brought TagRef to me, which i really like because of its simplicity. (Can solve 2. / maybe 3.)

For 1. we have the RFC145 but may need additional extensions for something like: https://github.com/NixOS/nixpkgs/blob/b286b8df1c0ecff4baa44a7224282aeccc6695c2/pkgs/build-support/trivial-builders/default.nix#L29
You want to automatically link from the documentation to the exact source code position (file/line/column) if there is such a reference. And we are doing this for, e.g., lib already.

Then for 3. I imagine that every of our manuals could export sitemaps (https://www.sitemaps.org/de/protocol.html) Which could be used in conjunction with TagRef. (Imagine every manual exports its available URL as well as the internal "tags", that could also be referenced from elsewhere in the nix ecosystem)

But regarding this topic i was mainly refering to references of 1. because moving doc-comments out of the source without replacement leaves the code-side of those references untracked. (We don't relly properly track them yet) But its a nice property we kind of "destroyed" here. (At least for automated tooling we cannot create backlinks here anymore)

infinisil: Roughly tracking the following relations:

1. Code <-> Documentation
2. Documenation <-> Documentation
3. Documentation -> external references. e.g. references from nixpkgs to nix manual

For each of those we should have some kind of solution.

fricklerhandwerk Brought TagRef to me, which i really like because of its simplicity. (Can solve 2. / maybe 3.)

For 1. we have the RFC145 but may need additional extensions for something like: https://github.com/NixOS/nixpkgs/blob/b286b8df1c0ecff4baa44a7224282aeccc6695c2/pkgs/build-support/trivial-builders/default.nix#L29
You want to automatically link from the documentation to the exact source code position (file/line/column) if there is such a reference. And we are doing this for, e.g., lib already.

Then for 3. I imagine that every of our manuals could export sitemaps (https://www.sitemaps.org/de/protocol.html) Which could be used in conjunction with TagRef. (Imagine every manual exports its available URLs as well as the internal "tags", that could also be referenced from elsewhere in the nix ecosystem)

But regarding this topic i was mainly refering to references of 1. because moving doc-comments out of the source without replacement leaves the code-side of those references untracked. (We don't relly properly track them yet) But its a nice property we kind of "destroyed" here. (At least for automated tooling we cannot create backlinks here anymore)

infinisil: Roughly tracking the following relations:

1. Code <-> Documentation
2. Documenation <-> Documentation
3. Documentation -> external references. e.g. references from nixpkgs to nix manual

For each of those we should have some kind of solution.

fricklerhandwerk Brought TagRef to me, which i really like because of its simplicity. (Can solve 2. / maybe 3.)

For 1. we have the RFC145 but may need additional extensions for something like: https://github.com/NixOS/nixpkgs/blob/b286b8df1c0ecff4baa44a7224282aeccc6695c2/pkgs/build-support/trivial-builders/default.nix#L29
You want to automatically link from the documentation to the exact source code position (file/line/column) if there is such a reference. And we are doing this for, e.g., lib already.

Then for 3. I imagine that every of our manuals could export sitemaps (https://www.sitemaps.org/de/protocol.html) Which could be used in conjunction with TagRef. (Imagine every manual exports its available URLs as well as the available "tags", that could be referenced from elsewhere in the nix ecosystem)

But regarding this topic i was mainly refering to references of 1. because moving doc-comments out of the source without replacement leaves the code-side of those references untracked. (We don't relly properly track them yet) But its a nice property we kind of "destroyed" here. (At least for automated tooling we cannot create backlinks here anymore)

infinisil: Roughly tracking the following relations:

1. Code <-> Documentation
2. Documenation <-> Documentation
3. Documentation -> external references. e.g. references from nixpkgs to nix manual

For each of those we should have some kind of solution.

fricklerhandwerk Brought TagRef (concept) to me, which i really like because of its simplicity. (Can solve 2. / maybe 3.)

For 1. we have the RFC145 but may need additional extensions for something like: https://github.com/NixOS/nixpkgs/blob/b286b8df1c0ecff4baa44a7224282aeccc6695c2/pkgs/build-support/trivial-builders/default.nix#L29
You want to automatically link from the documentation to the exact source code position (file/line/column) if there is such a reference. And we are doing this for, e.g., lib already.

Then for 3. I imagine that every of our manuals could export sitemaps (https://www.sitemaps.org/de/protocol.html) Which could be used in conjunction with TagRef. (Imagine every manual exports its available URLs as well as the available "tags", that could be referenced from elsewhere in the nix ecosystem)

But regarding this topic i was mainly refering to references of 1. because moving doc-comments out of the source without replacement leaves the code-side of those references untracked. (We don't relly properly track them yet) But its a nice property we kind of "destroyed" here. (At least for automated tooling we cannot create backlinks here anymore)

In reply to @qyriad:katesiria.org
@Johannes Kirschbauer @hsjobeki like how haskell's docs do it? all the types and whatnot in the source view in https://hackage.haskell.org/package/base-4.19.1.0/docs/src/Control.Arrow.html#Arrow are clickable and whatnot

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

In reply to @rina/:matrix.org
I am thinking of the functions in this file: https://github.com/NixOS/nixpkgs/blob/8f0d434c23d2ae84d0bf32622358361ade96d077/pkgs/build-support/writers/scripts.nix#L402

If you'd document them in the same ways as: https://github.com/nixos/nixpkgs/blob/master/lib/lists.nix#L42

We can add them to the index.

In reply to @rina/:matrix.org
I am thinking of the functions in this file: https://github.com/NixOS/nixpkgs/blob/8f0d434c23d2ae84d0bf32622358361ade96d077/pkgs/build-support/writers/scripts.nix#L402

If you'd document them in the same ways as: https://github.com/nixos/nixpkgs/blob/master/lib/lists.nix#L42

We can add them to the index. (Wiring should be trivial, i can help with that)

In reply to @danielsidhion:nixos.dev
Given there hasn't been a meeting on a Monday for essentially 2 months now, are you folks ok if I make a PR to say we only meet once a week on the nix.dev readme? Will also need to change the meeting invite on the calendar (I don't have access to it)

In reply to @johannes.kirschbauer:scs.ems.host
If you'd document them in the same ways as: https://github.com/nixos/nixpkgs/blob/master/lib/lists.nix#L42 We can add them to the index. (Wiring should be trivial, i can help with that)