!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

422 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
10 Mar 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @stablejoy:matrix.org
How can one integrate more of the manuals and documentation directly with Nix? Like if Nix could handle a greater share of the workload, maintaining the website might become simpler. Meaning if it can package anything can it package a website manual in a way?

It is in principle possible to write a static site generator in the Nix language, if that's what you mean. It has been done at least once. Whether that will make anything simpler to maintain is a matter of implementation quality and maturity of language tooling.

The practical question is always "who's gonna do it". And as @pennae said, we already have something that works. Someone just has to dig into it and make things happen.

09:07:08
@raitobezarius:matrix.orgraitobezariusRefer to the GitHub issues that samueldr opened09:55:36
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @stablejoy:matrix.org
How can one integrate more of the manuals and documentation directly with Nix? Like if Nix could handle a greater share of the workload, maintaining the website might become simpler. Meaning if it can package anything can it package a website manual in a way?

https://cs.tvl.fyi/depot/-/blob/users/sterni/nix/html/README.md
You mean something like this?

A dsl (by sterni for directly rendering html from nix code, of course this has major performance issues and i you'd be crazy to use it productively but its certainly an interesting experiement.

10:33:03
@fricklerhandwerk:matrix.orgfricklerhandwerkAlso this: https://github.com/static-nix/styx10:33:58
@ma27:nicht-so.sexyma27
In reply to @johannes.kirschbauer:scs.ems.host

https://cs.tvl.fyi/depot/-/blob/users/sterni/nix/html/README.md
You mean something like this?

A dsl (by sterni for directly rendering html from nix code, of course this has major performance issues and i you'd be crazy to use it productively but its certainly an interesting experiement.

OMG it's beautiful!
10:34:31
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @fricklerhandwerk:matrix.org
Also this: https://github.com/static-nix/styx
It even renders its own documentation. I'd still recommend against it, because it follows the same paradigm as any other static site generator.
10:36:26
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @fricklerhandwerk:matrix.org
Also this: https://github.com/static-nix/styx
* It even renders its own documentation. I'd still recommend against it, because it follows the same paradigm as any other static site generator. You won't gain much.
10:36:43
@fricklerhandwerk:matrix.orgfricklerhandwerk *

It even renders its own documentation: https://styx-static.github.io/styx-site/documentation/

I'd still recommend against it, because it follows the same paradigm as any other static site generator. You won't gain much.

10:37:15
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostThis styx thing looks like a differently styled version of our huge single page manual. My mouse catched fire from scrolling around inside of it^^10:44:35
@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

Show newer messages


Back to Room ListRoom Version: 6