Skip to content

Commit b7a831e

Browse files
committed
Remove docs.rs guideline
Crates.io now infers docs.rs for the documentation link of crates that do not specify one, so manually setting this metadata is no longer important.
1 parent 5c457df commit b7a831e

File tree

2 files changed

+0
-28
lines changed

2 files changed

+0
-28
lines changed

src/checklist.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
- [ ] Cargo.toml includes all common metadata ([C-METADATA])
3838
- authors, description, license, homepage, documentation, repository,
3939
readme, keywords, categories
40-
- [ ] Cargo.toml documentation key points to "https://docs.rs/CRATE" ([C-DOCS-RS])
4140
- [ ] Release notes document all significant changes ([C-RELNOTES])
4241
- **Predictability** *(crate enables legible code that acts how it looks)*
4342
- [ ] Smart pointers do not add inherent methods ([C-SMART-PTR])
@@ -104,7 +103,6 @@
104103
[C-PANIC-DOC]: documentation.html#c-panic-doc
105104
[C-LINK]: documentation.html#c-link
106105
[C-METADATA]: documentation.html#c-metadata
107-
[C-DOCS-RS]: documentation.html#c-docs-rs
108106
[C-RELNOTES]: documentation.html#c-relnotes
109107

110108
[C-SMART-PTR]: predictability.html#c-smart-ptr

src/documentation.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -174,32 +174,6 @@ example, serde sets `homepage` to "https://serde.rs", a dedicated
174174
website.
175175

176176

177-
<a id="c-docs-rs"></a>
178-
## Cargo.toml documentation key points to docs.rs (C-DOCS-RS)
179-
180-
In most cases the `documentation` key in a crate's `Cargo.toml` should
181-
be `"https://docs.rs/CRATE"`
182-
183-
```toml
184-
[package]
185-
name = "regex"
186-
version = "0.2.2"
187-
documentation = "https://docs.rs/regex"
188-
```
189-
190-
[docs.rs] provides automatic hosting of crate documentation, with a
191-
consistent style, inter-crate navigation, and advanced features not
192-
included in the stock rustdoc output. It is a central destination for
193-
documentation of all Rust crates. Rust users are familiar with docs.rs
194-
and expect to go there for their API documentation. A crate that
195-
directs their users to a different site for its documentation will be
196-
noticably segregating itself from the larger portion of the
197-
ecosystem. This may be desirable to crate authors in some situations
198-
but should be considered carefully.
199-
200-
[docs.rs]: https://docs.rs
201-
202-
203177
<a id="c-relnotes"></a>
204178
## Release notes document all significant changes (C-RELNOTES)
205179

0 commit comments

Comments
 (0)