11[ ![ CI] ( https://github.com/rust-lang/rustc-dev-guide/actions/workflows/ci.yml/badge.svg )] ( https://github.com/rust-lang/rustc-dev-guide/actions/workflows/ci.yml )
22
3-
43This is a collaborative effort to build a guide that explains how rustc works.
54The aim of the guide is to help new contributors get oriented to rustc,
65as well as to help more experienced folks in figuring out
76some new part of the compiler that they haven't worked on before.
87
9- [ You can read the latest version of the guide here. ] ( https://rustc-dev-guide.rust-lang.org/ )
8+ You may also find the [ rustc API docs ] useful.
109
11- You may also find the rustdocs [ for the compiler itself] [ rustdocs ] useful.
1210Note that these are not intended as a guide; it's recommended that you search
1311for the docs you're looking for instead of reading them top to bottom.
1412
15- [ rustdocs ] : https://doc.rust-lang.org/nightly/nightly-rustc
16-
1713For documentation on developing the standard library, see
1814[ ` std-dev-guide ` ] ( https://std-dev-guide.rust-lang.org/ ) .
1915
@@ -32,10 +28,10 @@ If you think something is missing, please open an issue about it!
3228problem!** In that case, what we will do is to schedule a bit of time
3329for you to talk with someone who ** does** know the code, or who wants
3430to pair with you and figure it out.
35- Then you can work on writing up what you learned.
31+ Then you can work on writing up what you learned.
3632
3733In general, when writing about a particular part of the compiler's code, we
38- recommend that you link to the relevant parts of the [ rustc rustdocs ] [ rustdocs ] .
34+ recommend that you link to the relevant parts of the [ rustc API docs ] .
3935
4036The guide has a much lower bar for what it takes for a PR to be merged.
4137Check out the forge documentation for [ our policy] [ forge_policy ] .
@@ -75,3 +71,5 @@ This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.g
7571You can use the [ rustc-josh-sync] ( https://github.com/rust-lang/josh-sync ) tool to perform synchronization.
7672
7773You can find a guide on how to perform the synchronization [ here] ( ./src/external-repos.md#synchronizing-a-josh-subtree ) .
74+
75+ [ rustc API docs ] : https://doc.rust-lang.org/nightly/nightly-rustc
0 commit comments