!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

383 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 71 Servers

Load older messages


SenderMessageTime
10 Mar 2024
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostNavigation is a bit better because it has the static side bar. Seems really low in terms of interactivity. I know this is not serious. Just exploring what other people do 🌕️10:47:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
This styx thing looks like a differently styled version of our huge single page manual.
My mouse catched fire from scrolling around inside of it^^
🙄 Yeah that's merely about some parameter juggling. Apart from that, there always should be single-page rendering, and that's just as much of a valid way for reading documents. I think it's a regression that the Nix manual did not keep the single page as an alternative. The dynamic search sucks, and you effectively need an entire web browser for it to work.
10:47:14
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @fricklerhandwerk:matrix.org
🙄 Yeah that's merely about some parameter juggling. Apart from that, there always should be single-page rendering, and that's just as much of a valid way for reading documents. I think it's a regression that the Nix manual did not keep the single page as an alternative. The dynamic search sucks, and you effectively need an entire web browser for it to work.
Oh good point. I think i'll add this to danielsidhion's list
10:48:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
Navigation is a bit better because it has the static side bar.
Seems really low in terms of interactivity.

I know this is not serious. Just exploring what other people do 🌕️
And that is literally style sheet juggling
10:48:13
@fricklerhandwerk:matrix.orgfricklerhandwerk

The serious questions I would ask about a data transformation engine (which a static site generator is):

  • What are the programmable interfaces?
  • What are the data structures it transforms?
  • Which languages are used to define data and transformations?
10:53:25
@fricklerhandwerk:matrix.orgfricklerhandwerkHere's one from a different ecosystem: https://docs.racket-lang.org/scribble/10:53:46
11 Mar 2024
@wamirez:matrix.orgwamirez changed their display name from Daniel Ramirez to wamirez.10:57:18
@wamirez:matrix.orgwamirez changed their profile picture.10:57:23
12 Mar 2024
@wiseh:matrix.org@wiseh:matrix.org removed their display name Dioprz.03:44:07
@wiseh:matrix.org@wiseh:matrix.org left the room.03:44:09
@dioprz:matrix.orgDiego joined the room.03:54:42
@dioprz:matrix.orgDiego changed their display name from dioprz to Diego.04:41:03
13 Mar 2024
@ktemkin:katesiria.org@ktemkin:katesiria.org changed their display name from Kate Temkin to [K]ate Temkin.02:56:13
@danielsidhion:nixos.devdanielsidhionJust saw https://github.com/NixOS/nixos-homepage/issues/1251 and wanted to check - is anyone already taking any action to bring the manuals back to the previous appearance? If not, I'll get started looking into that13:06:09
* @infinisil:matrix.orginfinisil isn't 13:14:12
14 Mar 2024
@federicodschonborn:matrix.org@federicodschonborn:matrix.org left the room.02:04:32
@danielsidhion:nixos.devdanielsidhion Draft PR to fix the stylesheet situation: https://github.com/NixOS/nixpkgs/pull/295847
Automatic header link buttons are still not there, because I need to extend nixos-render-docs more to allow that. Regardless of it, I appreciate anyone who can check out that PR, build the manuals (nix build .#htmlDocs.nixpkgsManual and nix build .#htmlDocs.nixosManual) and inspect the new styles and let me know if they see anything that needs fixing
10:47:43
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

Question what outputs of our documentation do exist ?

Someone confirm / disagree with this list?

NixOS manual

Web
man page
epub

nixpkgs manual

Web
epub
11:53:00
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manual could be build as part of our package collection? 12:05:52
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be build as part of our package collection? 12:06:05
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostOr is that just because nobody added them yet.12:06:31
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be built as part of our package collection? 12:06:41
@picnoir:alternativebit.fr@picnoir:alternativebit.fr joined the room.12:07:06
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be built as part of our package collection? This would make it easier to answer the "outputs" question. 12:08:02
@picnoir:alternativebit.fr@picnoir:alternativebit.fr

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :)

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

12:09:00
@picnoir:alternativebit.fr@picnoir:alternativebit.fr *

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :) So let's go with this matrix channel.

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

12:09:17
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Or is that just because nobody added them yet. (Some are in flake.nix it seems but not in the pkgs itself) 12:10:13
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Or is that just because nobody added them yet. (Web outputs are in flake.nix it seems but not in the pkgs itself) 12:10:49
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @picnoir:alternativebit.fr

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :) So let's go with this matrix channel.

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

I think this matrix channel is always best for asking about documentation concerns.
12:18:41
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

Picnoir: can you give some more details:

there's a lot of hyperlinks pointing to the manual on the web

What exact links, do you mean on the nixos website or in nix.dev?

the manual on the web.

Do you mean all the manuals? Or the nixpkgs manual ? or the nixos manual ?

12:22:01

Show newer messages


Back to Room ListRoom Version: 6