diff options
author | Frederik Rietdijk <fridh@fridh.nl> | 2019-10-20 12:17:58 +0200 |
---|---|---|
committer | Frederik Rietdijk <fridh@fridh.nl> | 2019-10-20 13:35:04 +0200 |
commit | 95dfbe2d632b71a72634d2d65e3f738f500ee5ce (patch) | |
tree | c3da9c73c48a65a204e47de113c82e9efdac037a /doc/contributing.xml | |
parent | af7378397fafd63384c4c7a28ba22b0803b00a18 (diff) |
doc: organize chapters into parts, and reduce toc depth
Reorganize the chapters into parts and reduce the TOC depth to make the TOC useful again. The top-level TOC is very brief, but that is fine because every part will have its own TOC. Section titles of languages/frameworks are also simplified to just the name of the language/framework.
Diffstat (limited to 'doc/contributing.xml')
-rw-r--r-- | doc/contributing.xml | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/doc/contributing.xml b/doc/contributing.xml deleted file mode 100644 index b0266043775fb..0000000000000 --- a/doc/contributing.xml +++ /dev/null @@ -1,30 +0,0 @@ -<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 the Nixpkgs manual are in the <filename -xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository. - </para> - <para> - You can quickly check your edits with <command>make</command>: - </para> -<screen> -<prompt>$ </prompt>cd /path/to/nixpkgs/doc -<prompt>$ </prompt>nix-shell -<prompt>[nix-shell]$ </prompt>make -</screen> - <para> - If you experience problems, run <command>make debug</command> to help understand the docbook errors. - </para> - <para> - After making modifications to the manual, it's important to build it before committing. You can do that as follows: -<screen> -<prompt>$ </prompt>cd /path/to/nixpkgs/doc -<prompt>$ </prompt>nix-shell -<prompt>[nix-shell]$ </prompt>make clean -<prompt>[nix-shell]$ </prompt>nix-build . -</screen> - If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>. - </para> -</chapter> |