diff options
| author | Robert Hensing <roberth@users.noreply.github.com> | 2023-01-03 13:52:17 +0100 |
|---|---|---|
| committer | Robert Hensing <robert@roberthensing.nl> | 2023-01-10 22:30:41 +0100 |
| commit | 6ae4d762d0a1b208eaa47e9bd8960571ac908af7 (patch) | |
| tree | 201f2f2642d8698115269dac38c0c6936a4b49e7 /doc/manual/src | |
| parent | da4d4feacf76a829ee7929c3d69f6f3d6ba86f1f (diff) | |
doc/manual/src/contributing/hacking.md: Apply suggestion
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'doc/manual/src')
| -rw-r--r-- | doc/manual/src/contributing/hacking.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index b9b327fba..aeb0d41b3 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -279,4 +279,6 @@ rm $(git ls-files doc/manual/ -o | grep -F '.md') && rmdir doc/manual/src/comman 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. -If the `@docroot@` literal appears in an error message from the `mdbook-linkcheck` tool, the `@docroot@` replacement needs to be applied to the (probably) generated source file that mentions it. See existing `@docroot@` logic in the [Makefile]. Regular markdown files that are not copied to other markdown files do have a base path of their own and they can use relative paths instead of `@docroot@`. +If the `@docroot@` literal appears in an error message from the `mdbook-linkcheck` tool, the `@docroot@` replacement needs to be applied to the generated source file that mentions it. +See existing `@docroot@` logic in the [Makefile]. +Regular markdown files used for the manual have a base path of their own and they can use relative paths instead of `@docroot@`. |