itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert "remove reference to incomplete crates.io feature from docs"

Browse Source 
This reverts commit 1735917adc11aaa14011a187baf47a320f1c5bc5.

As discussed in #13660, my stance on removing the docs was if there
wasn't a path forward.
There is work progressing on the docs.rs side which will unblock the
crates.io side.

If the concern for removing the docs is for new crates, then no harm in
removing it for now but also little benefit.
If its to get existing crates to change, I don't think that ecosystem
churn is worth it to try to get everyone to add the link and then remove
it again.
This commit is contained in:
Ed Page 2024-09-18 08:55:47 -05:00
parent 0461165eae
commit 78cda34a17
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/doc/src/reference/manifest.md
View File

@ -209,7 +209,9 @@ description = "A short description of my package"
### The `documentation` field
The `documentation` field specifies a URL to a website hosting the crate's
documentation.
documentation. If no URL is specified in the manifest file, [crates.io] will
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]
@ -217,6 +219,8 @@ documentation.
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