PistonDevelopers / PistonDevelopers/piston
Point docs to docs.rs
Open
Nobody has claimed this yet.
discussion
draft
- Dominant language
- Rust
- Stars
- 4.7k
- Forks
- 235
- Avg merge
- 1m
- Merged PRs (30d)
- 4
Description
The docs under http://docs.piston.rs/ are out of date and people are not using them because of docs.rs is more convenient. I think we should point the links over to docs.rs.
Is there a way to point to the latest crate version on docs.rs?
Contributor guide
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 locating the repository links that point to docs.piston.rs and compare them with the corresponding docs.rs crate URLs. Confirm how docs.rs selects the latest crate version, then update the links and verify that they reach the intended documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100