about summary refs log tree commit diff
path: root/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml
blob: 137e04bb313b36d672c5a91d05f1ff2a3414a7fe (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<chapter xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xml:id="chap-contributing">
 <title>Contributing to this manual</title>
 <para>
  The DocBook sources of NixOS' manual are in the <filename
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual">
nixos/doc/manual</filename> subdirectory of the <link
xlink:href="https://github.com/NixOS/nixpkgs">Nixpkgs</link> repository.
 </para>
 <para>
  You can quickly check your edits with the following:
 </para>
<screen>
<prompt>$ </prompt>cd /path/to/nixpkgs
<prompt>$ </prompt>nix-build nixos/release.nix -A manual.x86_64-linux
</screen>
 <para>
  If the build succeeds, the manual will be in
  <filename>./result/share/doc/nixos/index.html</filename>.
 </para>
</chapter>