summaryrefslogtreecommitdiffstats
path: root/lib/README.md
diff options
context:
space:
mode:
authorSilvan Mosberger <contact@infinisil.com>2023-12-05 03:33:53 +0100
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-12-08 01:26:31 +0100
commitf5dafbfa830337ea4c0d3227b27f957007342e47 (patch)
tree05f4433ffa2f5bc4a173194dcb6db4d39788d475 /lib/README.md
parentde9c084d9eb73559a0405a667e32883f29789771 (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 'lib/README.md')
-rw-r--r--lib/README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/README.md b/lib/README.md
index 220940bc2122..a886cf5bfb55 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -42,7 +42,7 @@ Reference documentation for library functions is written above each function as
These comments are processed using [nixdoc](https://github.com/nix-community/nixdoc) and [rendered in the Nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#chap-functions).
The nixdoc README describes the [comment format](https://github.com/nix-community/nixdoc#comment-format).
-See the [chapter on contributing to the Nixpkgs manual](https://nixos.org/manual/nixpkgs/#chap-contributing) for how to build the manual.
+See [doc/README.md](../doc/README.md) for how to build the manual.
## Running tests