commit f5dafbfa830337ea4c0d3227b27f957007342e47 · pyrox.dev/nixpkgs

+10 -6

doc/README.md

···

       1
       1
       -
       # Contributing to the Nixpkgs manual

     

       1
       1
       +
       # Contributing to the Nixpkgs reference manual

     

       2
       2
        
       

     

       3
       3
       -
       This directory houses the sources files for the Nixpkgs manual.

     

       3
       3
       +
       This directory houses the sources files for the Nixpkgs reference manual.

     

       4
       4
        
       

     

       5
       5
       -
       You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/).

     

       6
       6
       -
       The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`.

     

       5
       5
       +
       Going forward, it should only contain [reference](https://nix.dev/contributing/documentation/diataxis#reference) documentation.

     

       6
       6
       +
       For tutorials, guides and explanations, contribute to <https://nix.dev/> instead.

     

       7
       7
        
       

     

       8
       8
       -
       [Docs for Nixpkgs stable](https://nixos.org/manual/nixpkgs/stable/) are also available.

     

       8
       8
       +
       For documentation only relevant for contributors, use Markdown files and code comments in the source code.

     

       9
       9
        
       

     

       10
       10
       -
       If you're only getting started with Nix, go to [nixos.org/learn](https://nixos.org/learn).

     

       10
       10
       +
       Rendered documentation:

     

       11
       11
       +
       - [Unstable (from master)](https://nixos.org/manual/nixpkgs/unstable/)

     

       12
       12
       +
       - [Stable (from latest release)](https://nixos.org/manual/nixpkgs/stable/)

     

       13
       13
       +
       

     

       14
       14
       +
       The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`.

     

       11
       15
        
       

     

       12
       16
        
       ## Contributing to this documentation

     

       13
       17

+1 -1

doc/manual.md.in

···

       1
       1
       -
       # Nixpkgs Manual {#nixpkgs-manual}

     

       1
       1
       +
       # Nixpkgs Reference Manual {#nixpkgs-manual}

     

       2
       2
        
       ## Version @MANUAL_VERSION@

     

       3
       3
        
       

     

       4
       4
        
       ```{=include=} chapters

+9 -5

doc/preface.chapter.md

···

       6
       6
        
       Packages are available for several platforms, and can be used with the Nix

     

       7
       7
        
       package manager on most GNU/Linux distributions as well as [NixOS](https://nixos.org/nixos).

     

       8
       8
        
       

     

       9
       9
       -
       This manual primarily describes how to write packages for the Nix Packages collection

     

       10
       10
       -
       (Nixpkgs). Thus it’s mainly for packagers and developers who want to add packages to

     

       11
       11
       -
       Nixpkgs. If you like to learn more about the Nix package manager and the Nix

     

       12
       12
       -
       expression language, then you are kindly referred to the [Nix manual](https://nixos.org/nix/manual/).

     

       13
       13
       -
       The NixOS distribution is documented in the [NixOS manual](https://nixos.org/nixos/manual/).

     

       9
       9
       +
       This document is the user [_reference_](https://nix.dev/contributing/documentation/diataxis#reference) manual for Nixpkgs.

     

       10
       10
       +
       It describes entire public interface of Nixpkgs in a concise and orderly manner, and all relevant behaviors, with examples and cross-references.

     

       11
       11
       +
       

     

       12
       12
       +
       To discover other kinds of documentation:

     

       13
       13
       +
       - [nix.dev](https://nix.dev/): Tutorials and guides for getting things done with Nix

     

       14
       14
       +
       - [NixOS **Option Search**](https://search.nixos.org/options) and reference documentation

     

       15
       15
       +
       - [Nixpkgs **Package Search**](https://search.nixos.org/packages)

     

       16
       16
       +
       - [**NixOS** manual](https://nixos.org/manual/nixos/stable/): Reference documentation for the NixOS Linux distribution

     

       17
       17
       +
       - [`CONTRIBUTING.md`](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md): Contributing to Nixpkgs, including this manual

     

       14
       18
        
       

     

       15
       19
        
       ## Overview of Nixpkgs {#overview-of-nixpkgs}

     

       16
       20

+1 -1

lib/README.md

···

       42
       42
        
       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).

     

       43
       43
        
       The nixdoc README describes the [comment format](https://github.com/nix-community/nixdoc#comment-format).

     

       44
       44
        
       

     

       45
       45
       -
       See the [chapter on contributing to the Nixpkgs manual](https://nixos.org/manual/nixpkgs/#chap-contributing) for how to build the manual.

     

       45
       45
       +
       See [doc/README.md](../doc/README.md) for how to build the manual.

     

       46
       46
        
       

     

       47
       47
        
       ## Running tests

     

       48
       48