!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

408 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 76 Servers

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


SenderMessageTime
14 Dec 2023
@infinisil:matrix.orginfinisilI guess contributor docs being rendered (as I described it in https://github.com/NixOS/nixpkgs/issues/244056) is the problem. Rather it's that older versions of the documentation is too easily accessible if it were in the user manuals22:08:11
@infinisil:matrix.orginfinisil * I guess contributor docs being rendered (as I described it in https://github.com/NixOS/nixpkgs/issues/244056) is the problem. Rather it's that older versions of the contributor documentation is too easily accessible if it were in the user manuals22:08:20
@jade_:matrix.org@jade_:matrix.org ah yeah, I am definitely not in favour of putting it in the user manual 22:08:35
@infinisil:matrix.orginfinisilThough using the GitHub markdown rendering is also kind of nice because it's one less thing to worry about and maintain22:09:05
@jade_:matrix.org@jade_:matrix.orgit's useful to delineate this because the style of writing for user manuals and contributor-only docs is rather different22:09:13
@jade_:matrix.org@jade_:matrix.orgi wonder if we could reuse the nix.dev code somehow without causing ourselves too much pain?22:09:25
@infinisil:matrix.orginfinisil I think ideally all .md files in Nixpkgs would be collected somehow and rendered together 22:10:20
@infinisil:matrix.orginfinisil (well, user docs are also written in .md, those shouldn't be included obviously) 22:11:16
@infinisil:matrix.orginfinisilOh, but alternatively, what if the render pipelines are separate, but the website puts them into a single document22:11:54
@infinisil:matrix.orginfinisil Such that when you go to nixos.org/manual/nixpkgs, it shows you both stable/unstable versions of the released user documentation, but also the latest contributor documentation from master 22:12:57
@infinisil:matrix.orginfinisilThis is generally what I think we should have: A single page that collects materials from different repos22:13:22
@infinisil:matrix.orginfinisilAnd actually we did make a step in that direction with nix.dev: https://nix.dev/reference/nix-manual22:13:41

Show newer messages


Back to Room ListRoom Version: 6