!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

439 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

Load older messages


SenderMessageTime
2 Nov 2023
@adtya:adtya.xyzAdithya changed their profile picture.13:28:40
@adtya:adtya.xyzAdithya changed their profile picture.13:29:18
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @infinisil:matrix.org
asymmetric: Could you make a new nixdoc release?
https://github.com/nix-community/nixdoc/releases/tag/v2.5.1
14:38:55
@delroth:delroth.net@delroth:delroth.net joined the room.16:56:32
@janik0:matrix.org@janik0:matrix.org A co worker of mine recently installed NixOS for the first time and when looking for something like how to install nixos the wiki shows up first and has a more fitting name since it shows up as "NixOS Installation Guide" and the offical manual guide shows up as "NixOS 23.05 manual | Nix & NixOS" which confused him since if it's the first time you doing anything nix related you don't know that the wiki is user maintained and unoffical and that many articals are chronically outdated. And I'm unsure what to do about it since clearly some people think that a article like that should exist in the wiki. 17:10:09
@toonn:matrix.orgtoonn I've noticed this shift of people's assumption about what a wiki is too. Its origin is definitely communally edited articles. Nixos.org does point to the manual. Not sure how to influence search results. 17:14:05
@janik0:matrix.org@janik0:matrix.org * A coworker of mine recently installed NixOS for the first time and when looking for something like how to install nixos the wiki shows up first and has a more fitting name since it shows up as "NixOS Installation Guide" and the offical manual guide shows up as "NixOS 23.05 manual | Nix & NixOS" which confused him since if it's the first time you doing anything nix related you don't know that the wiki is user maintained and unoffical and that many articals are chronically outdated. And I'm unsure what to do about it since clearly some people think that a article like that should exist in the wiki. 17:17:18
@fricklerhandwerk:matrix.orgfricklerhandwerk

We'll improve search results by breaking down the manuals into smaller pages so they are more likely to get fully indexed by search engines, and by adding more relevant metadata.

The first step is probably not super hard to do, just needs some concentration. It has something to do with theinto-file directive: https://github.com/search?q=repo%3ANixOS%2Fnixpkgs%20into-file&type=code

19:26:55
@fricklerhandwerk:matrix.orgfricklerhandwerk *

We'll improve search results by breaking down the manuals into smaller pages so they are more likely to get fully indexed by search engines, and by adding more relevant metadata.

The first step is probably not super hard to do with a Python background, just needs some concentration. It has something to do with theinto-file directive: https://github.com/search?q=repo%3ANixOS%2Fnixpkgs%20into-file&type=code

19:27:31
@fricklerhandwerk:matrix.orgfricklerhandwerkAnd well, the rest requires Someone™ to take time and curate the NixOS manuals. The docs team is currently fully busy with the Nix manual, nix.dev, and tiny slices of the Nixpkgs manual.19:29:03
@delroth:delroth.net@delroth:delroth.netugh FYI: nix.dev is currently semi-borked because we're moving the DNS provider from cloudflare to netlify, and that's causing issues with provisioning the TLS certificate for the website. I'm monitoring, hoping it fixes itself in the next few minutes.19:48:05
@delroth:delroth.net@delroth:delroth.netah great, it's resolved already, afaict19:48:29
@delroth:delroth.net@delroth:delroth.netso let it be known there were possibly errors for ~5-10min19:48:49
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
@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

Show newer messages


Back to Room ListRoom Version: 6