diff options
| author | Robert Hensing <roberth@users.noreply.github.com> | 2023-12-10 07:07:20 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-10 07:07:20 +0100 |
| commit | 8d20c2011ef651e664086e7c2e31c3cdba3bb5b3 (patch) | |
| tree | 9b96c236e417ff87d00fc89730fe2475383a529b /doc/README.md | |
| parent | 584463c7449a116f095eb456116f728c2b31497b (diff) | |
| parent | f5dafbfa830337ea4c0d3227b27f957007342e47 (diff) | |
| download | nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar.gz nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar.bz2 nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar.lz nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar.xz nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.tar.zst nixlib-8d20c2011ef651e664086e7c2e31c3cdba3bb5b3.zip | |
Merge pull request #272183 from infinisil/nixpkgs-reference
doc: Rename to Nixpkgs reference manual and restate purpose
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 e9f2a53c355d..616409beaaf5 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 |