7fb1e3af77
Instead of putting a README in the directory where the manual is written, put the information from it straight in the docs themselves. It's a bit untrivial to guess the manual is located exactly there for contributers.
22 lines
819 B
XML
22 lines
819 B
XML
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xml:id="chap-contributing">
|
|
<title>Contributing to this documentation</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/nixos/doc/manual
|
|
<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>
|