diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 4c1eafd45..543259ba3 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -63,6 +63,17 @@

Cross-compiling

This approach is also useful for setting cargo features.

+

Testing documentation builds in CI

+

+ When you start using docs.rs metadata or #[cfg(docsrs)] in your code, you might run into issues + where your code builds fine locally but fails on docs.rs. + + To avoid this, you can add cargo docs-rs to + your test-suite. + + While it doesn't perfectly replicate our build environment, it can catch many common issues. +

+

Testing documentation builds locally

{%- set build_subcommand = "{}/blob/master/README.md#build-subcommand"|format(docsrs_repo) -%}