Skip to content

Commit

Permalink
Auto merge of #12146 - ehuss:crates-io-docs-rs-clarification, r=weiha…
Browse files Browse the repository at this point in the history
…nglo

docs: Clarify that crates.io doesn't link to docs.rs right away.

This implements the suggestion in #11685 (comment) to help clarify the confusion about the documentation link not appearing on crates.io.

There may be more to follow up here, perhaps with changes on crates.io or docs.rs, to help with some of the confusion. For example, #11777, or changing crates.io to always link to docs.rs, and have docs.rs provide better error pages when docs aren't available. This is just intended as a short-term fix to address some of the confusion.
  • Loading branch information
bors committed May 16, 2023
2 parents 6b872ab + bd30f01 commit 09276c7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,14 +203,17 @@ 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]
# ...
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
Expand Down

0 comments on commit 09276c7

Please sign in to comment.