lix-project/lix
20
58
Fork 31
Code Issues 359 Code Review (Gerrit) Projects 3 Releases Wiki Activity

doc/manual: Document hacking on the manual links

Browse source
This commit is contained in:
Robert Hensing 2023-01-03 10:29:05 +01:00
parent e79f935718
commit d5c8289f1e
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/manual/src/contributing/hacking.md
View file

@ -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.