diff options
| author | Robert Hensing <robert@roberthensing.nl> | 2023-01-03 10:29:05 +0100 |
|---|---|---|
| committer | Robert Hensing <robert@roberthensing.nl> | 2023-01-10 22:30:41 +0100 |
| commit | d5c8289f1e39397fcf562fa750719e9e86569041 (patch) | |
| tree | 6c07a12c92ee3fc00bd43bfd149695b42405e265 /doc/manual/src/contributing | |
| parent | e79f93571862f62447b7c95d10e797369a0be880 (diff) | |
doc/manual: Document hacking on the manual links
Diffstat (limited to 'doc/manual/src/contributing')
| -rw-r--r-- | doc/manual/src/contributing/hacking.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index c9da1962f..cd3788efc 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -249,3 +249,22 @@ search/replaced in it for each new build. The installer now supports a `--tarball-url-prefix` flag which _may_ have solved this need? --> + +### Checking the manual links + +The build checks for broken internal links, but this happens late in the process, +so `nix build .` is not suitable for iterating. To check the manual incrementally, run: + +```console +make html -j $NIX_BUILD_CORES +``` + +When iterating on the makefile, run: + +```console +rm $(git ls-files doc/manual/ -o | grep -F '.md') && rmdir doc/manual/src/command-ref/new-cli && make html -j $NIX_BUILD_CORES +``` + +If a broken link occurs in a snippet that was inserted into multiple generated files in different directories, use `@docroot@` to reference the `doc/manual/src` directory. + +`mdbook-linkcheck` does not implement fragment checking yet. |