tjh.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 <filename
7xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository.
8 </para>
9 <para>
10 You can quickly check your edits with <command>make</command>:
11 </para>
12<screen>
13<prompt>$ </prompt>cd /path/to/nixpkgs/doc
14<prompt>$ </prompt>nix-shell
15<prompt>[nix-shell]$ </prompt>make
16</screen>
17 <para>
18 If you experience problems, run <command>make debug</command> to help understand the docbook errors.
19 </para>
20 <para>
21 After making modifications to the manual, it's important to build it before committing. You can do that as follows:
22<screen>
23<prompt>$ </prompt>cd /path/to/nixpkgs/doc
24<prompt>$ </prompt>nix-shell
25<prompt>[nix-shell]$ </prompt>make clean
26<prompt>[nix-shell]$ </prompt>nix-build .
27</screen>
28 If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>.
29 </para>
30</chapter>