Opting Out
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
Hello!
I'd like to opt-out from having documentation served on docs.rs for some of my crates. How can I do this?
One idea is that docs.rs would read the documentation link in the Cargo.toml file for a given crate and only serve documentation for the crate if it points to docs.rs. If it doesn't, then visiting docs.rs/{crate} would redirect to the URL in the documentation value.
Another approach is to expand #73 so that package.metadata.docs.rs includes an opt-out key that can be set to true to opt-out.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing issue #73 and the proposed Cargo.toml fields: the documentation link and package.metadata.docs.rs. Decide whether opting out should redirect docs.rs/{crate} to the documentation URL or use an opt-out key, then specify the selected behavior and its completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100