From e6ca9b84c33f4f2a653c558ebbaf1dda9751ab79 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 9 Oct 2026 10:51:30 +0200 Subject: [PATCH] doc/readme: improve call-to-action for documentation help --- doc/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 032df28340b64..fb2e22ecfca4f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -10,7 +10,10 @@ There are renderings for the [rolling release](https://nixos.org/manual/nixpkgs/ > [!NOTE] > -> We are actively restructuring our documentation to be more beginner friendly. +> The Documentation Team is working on making the documentation more accessible, coherent, and beginner-friendly. +> Consult the [vision](https://github.com/NixOS/nix.dev/tree/master/maintainers/vision.md). +> +> If you would like to help, [get in touch](#getting-help) with the Documentation Team! > We are actively working to generate reference documentation from the [doc-comments](https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md) present in code, which also lets you view it locally with the `:doc` command in `nix repl`, e.g.: @@ -432,3 +435,5 @@ Check the [list of possible replacement patterns](https://github.com/executableb ## Getting help If you need documentation-specific help or reviews, ping [@NixOS/documentation-team](https://github.com/orgs/nixos/teams/documentation-team) on your pull request. + +The official communication channels are available at the [official NixOS website](https://nixos.org/community/teams/documentation/), under `Contact`.