diff options
| author | Silvan Mosberger <contact@infinisil.com> | 2023-12-05 03:33:53 +0100 |
|---|---|---|
| committer | Silvan Mosberger <silvan.mosberger@tweag.io> | 2023-12-08 01:26:31 +0100 |
| commit | f5dafbfa830337ea4c0d3227b27f957007342e47 (patch) | |
| tree | 05f4433ffa2f5bc4a173194dcb6db4d39788d475 /doc/README.md | |
| parent | de9c084d9eb73559a0405a667e32883f29789771 (diff) | |
doc: Rename to Nixpkgs reference manual and state purpose
For the time being, we're moving towards https://nix.dev/ containing all tutorials and guides. The Nixpkgs manual is reinforced to be a _reference_ manual. While it's not just reference for now, that's what the docs team is working towards. This commits rewrites the Nixpkgs manual introduction to reflect that and point to some more useful links. The contribution docs are updated similarly so it's not missed. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/README.md b/doc/README.md index 9dee2d30d7305..d441a3b7204a5 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,13 +1,17 @@ -# Contributing to the Nixpkgs manual +# Contributing to the Nixpkgs reference manual -This directory houses the sources files for the Nixpkgs manual. +This directory houses the sources files for the Nixpkgs reference manual. -You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/). -The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`. +Going forward, it should only contain [reference](https://nix.dev/contributing/documentation/diataxis#reference) documentation. +For tutorials, guides and explanations, contribute to <https://nix.dev/> instead. + +For documentation only relevant for contributors, use Markdown files and code comments in the source code. -[Docs for Nixpkgs stable](https://nixos.org/manual/nixpkgs/stable/) are also available. +Rendered documentation: +- [Unstable (from master)](https://nixos.org/manual/nixpkgs/unstable/) +- [Stable (from latest release)](https://nixos.org/manual/nixpkgs/stable/) -If you're only getting started with Nix, go to [nixos.org/learn](https://nixos.org/learn). +The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`. ## Contributing to this documentation |