Skip to content

Commit

Permalink
docs: Clarify that crates.io doesn't link to docs.rs right away.
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss committed May 16, 2023
1 parent 6b872ab commit bd30f01
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 bd30f01

Please sign in to comment.