Skip to content

Commit

Permalink
Add guidance on setting homepage in manifest
Browse files Browse the repository at this point in the history
  • Loading branch information
dtolnay committed Jan 14, 2024
1 parent 92395d9 commit 7ccb4d3
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 7ccb4d3

Please sign in to comment.