Merge branch 'docs-runes' into 'main'

CONTRIBUTING.md: Improve wording about docs builds recommendations

See merge request tpo/core/arti!1090
This commit is contained in:
Ian Jackson 2023-03-31 16:52:31 +00:00
commit c8973ae248
1 changed files with 5 additions and 2 deletions

View File

@ -187,7 +187,10 @@ information.
This code does not attempt to be indistinguishable from the current Tor
implementation.
When building the docs with `cargo doc`, use `--all-features`, or you may
find broken links. (We welcome fixes to links broken with `--all-features`.)
When building the docs with `cargo doc`, use `--workspace --all-features`,
or you may find broken links.
(We welcome fixes to links broken with `--all-features`.
`cargo doc --workspace --all-features --document-private-items`
is also supported, to reveal (unstable) internal information.)
Enjoy hacking on arti!