nixpkgs/nixos/doc/manual/contributing-to-this-manual.chapter.md
Ryan Mulligan 7501467903 nixos/doc: convert "Contributing to this manual" to CommonMark
Also updates it to mention running md-to-db.sh.
2021-05-22 18:14:49 -07:00

14 lines
541 B
Markdown

# Contributing to this manual {#chap-contributing}
The DocBook and CommonMark sources of NixOS' manual are in the [nixos/doc/manual](https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual) subdirectory of the [Nixpkgs](https://github.com/NixOS/nixpkgs) repository.
You can quickly check your edits with the following:
```ShellSession
$ cd /path/to/nixpkgs
$ ./nixos/doc/manual/md-to-db.sh
$ nix-build nixos/release.nix -A manual.x86_64-linux
```
If the build succeeds, the manual will be in `./result/share/doc/nixos/index.html`.