rust-lang / rust-lang/rustc-dev-guide

Improve compiler top-level description in rustc-dev guide

Open
#1,691 0 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-compiler-architecture E-hard T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

Location

https://rustc-dev-guide.rust-lang.org/overview.html

Summary

@akarahdev wrote a very nice top-level overview on reddit which I think could be used to improve the existing (and a bit outdated) overview of the compiler.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the overview at rustc-dev-guide.rust-lang.org/overview.html and compare it with the referenced Reddit explanation of how Rust transforms into machine code. Update the compiler's top-level description so it incorporates the useful overview while remaining appropriate for the guide. Done means the overview page clearly reflects the improved explanation.

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
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.