From bd30f01904499f8d70e74d98d89aaefb371d39e9 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Tue, 16 May 2023 11:33:55 -0700 Subject: [PATCH] docs: Clarify that crates.io doesn't link to docs.rs right away. --- src/doc/src/reference/manifest.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index 49d5b96c690..5a3d60ccc35 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -203,7 +203,8 @@ description = "A short description of my package" The `documentation` field specifies a URL to a website hosting the crate's documentation. If no URL is specified in the manifest file, [crates.io] will -automatically link your crate to the corresponding [docs.rs] page. +automatically link your crate to the corresponding [docs.rs] page when the +documentation has been built and is available (see [docs.rs queue]). ```toml [package] @@ -211,6 +212,8 @@ automatically link your crate to the corresponding [docs.rs] page. documentation = "https://docs.rs/bitflags" ``` +[docs.rs queue]: https://docs.rs/releases/queue + #### The `readme` field The `readme` field should be the path to a file in the package root (relative