rust-lang / rust-lang/rustc-dev-guide
inline `tests/mir-opt` docs into the dev-guide
Open
Beginner friendly
Nobody has claimed this yet.
needs-triage
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
https://github.com/rust-lang/rust/blob/HEAD/tests/mir-opt/README.md has quite a lot of info but it's hard to find. We should:
- Move all its info into the guide (https://github.com/rust-lang/rustc-dev-guide/pull/2718 is a good start)
- Delete it and replace it with a link to the new guide docs
We should not just duplicate the docs, that'll cause them to get out of sync.
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
Read tests/mir-opt/README.md and the rustc-dev-guide PR 2718 to identify the information that belongs in the guide. Move that information into the relevant guide documentation, remove the standalone README content, and leave a link to the new docs so the information is maintained in one place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100