From 7ccb4d3a7932c87eb442c5b3fc437dd7f8bccbea Mon Sep 17 00:00:00 2001 From: David Tolnay Date: Sat, 13 Jan 2024 18:56:30 -0800 Subject: [PATCH] Add guidance on setting homepage in manifest --- src/doc/src/reference/manifest.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index cb69745372a..ae9b2f49e70 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -244,9 +244,13 @@ package. ```toml [package] # ... -homepage = "https://serde.rs/" +homepage = "https://serde.rs" ``` +A value should only be set for `homepage` if there is a dedicated website for +the crate other than the source repository or API documentation. Do not make +`homepage` redundant with either the `documentation` or `repository` values. + ### The `repository` field The `repository` field should be a URL to the source repository for your @@ -255,7 +259,7 @@ package. ```toml [package] # ... -repository = "https://github.com/rust-lang/cargo/" +repository = "https://github.com/rust-lang/cargo" ``` ### The `license` and `license-file` fields