Add a link to the GitHub web editor for the current documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
@SOF3 brought this up in #contribute: currently, making a PR to improve the documentation for a crate is somewhat tedious: find the link to the GitHub project, find where the documentation lives in the code (which doesn't always correspond to the module structure, especially with macros), fork the project, and only then make the edits. It would be nice to have a direct link to the GitHub web editor, which lets you suggest fixes immediately without all the setup.
Doing this per-page isn't so hard, but per-item would require rustdoc support. It would also be nice to have rustdoc support in general, since that would let it be used for the standard library as well.
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 how docs.rs generates documentation pages and how rustdoc could expose links for individual items. Compare the per-page web-editor link described in the issue with the broader per-item and standard-library requirements; done means the supported scope and integration path are defined.
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
- 30/100