rust-lang / rust-lang/rustc_public
Create a StableMIR section in Rust Compiler Development Guide
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 125
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
We should create a section to the rustc dev guide about StableMIR. Here are a few topics that we may want to include:
- Intro
- What is StableMIR
- Add a few use case examples
- Troubleshooting and fixing issues in StableMIR
- Focused on common errors that can emerge StableMIR after "unrelated" changes to Rustc.
- How to extend StableMIR
- Focus on making changes to StableMIR, such as adding new features.
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 with the Rust Compiler Development Guide and the existing StableMIR material, if any. Define the section around an introduction with use cases, troubleshooting common errors after unrelated rustc changes, and guidance for extending StableMIR. Done means all three topics are documented in the guide with enough context for contributors to use and extend StableMIR.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100