pyrox.dev
1<chapter xmlns="http://docbook.org/ns/docbook"
2 xmlns:xlink="http://www.w3.org/1999/xlink"
3 xml:id="chap-contributing">
4 <title>Contributing to this documentation</title>
5 <para>
6 The DocBook sources of the Nixpkgs manual are in the
7 <filename
8xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
9 subdirectory of the Nixpkgs repository.
10 </para>
11 <para>
12 You can quickly check your edits with <command>make</command>:
13 </para>
14<screen>
15 $ cd /path/to/nixpkgs/doc
16 $ nix-shell
17 [nix-shell]$ make
18</screen>
19 <para>
20 If you experience problems, run <command>make debug</command> to help
21 understand the docbook errors.
22 </para>
23 <para>
24 After making modifications to the manual, it's important to build it before
25 committing. You can do that as follows:
26<screen>
27 $ cd /path/to/nixpkgs/doc
28 $ nix-shell
29 [nix-shell]$ make clean
30 [nix-shell]$ nix-build .
31</screen>
32 If the build succeeds, the manual will be in
33 <filename>./result/share/doc/nixpkgs/manual.html</filename>.
34 </para>
35</chapter>