Skip to content

Commit 702d186

Browse files
committed
Add color to C-DOCS-RS. Fixes #76
1 parent a06646c commit 702d186

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1063,7 +1063,20 @@ Cargo.toml should contain a note next to the version to remember to bump the
10631063
<a id="c-docs-rs"></a>
10641064
### Cargo.toml documentation key points to docs.rs (C-DOCS-RS)
10651065

1066-
It should point to `"https://docs.rs/$crate"`.
1066+
In most cases the `documentation` key in a crate's `Cargo.toml` should
1067+
be `"https://docs.rs/$crate"`.
1068+
1069+
[docs.rs] provides automatic hosting of crate documentation, with a
1070+
consistent style, inter-crate navigation, and advanced features not
1071+
included in the stock rustdoc output. It is a central destination for
1072+
documentation of all Rust crates. Rust users are familiar with docs.rs
1073+
and expect to go there for their API documentation. A crate that
1074+
directs their users to a different site for its documentation will be
1075+
noticably segregating itself from the larger portion of the
1076+
ecosystem. This may be desirable to crate authors in some situations
1077+
but should be considered carefully.
1078+
1079+
[docs.rs]: https://docs.rs
10671080

10681081
[C-RELNOTES]: #c-relnotes
10691082
<a id="c-relnotes"></a>

0 commit comments

Comments
 (0)