Merge pull request #2690 from rust-lang/tshepang/sembr

sembr readme

Author: tshepang

README.md

@@ -1,45 +1,40 @@
 [![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)
 
-
-This is a collaborative effort to build a guide that explains how rustc
-works. The aim of the guide is to help new contributors get oriented
-to rustc, as well as to help more experienced folks in figuring out
+This is a collaborative effort to build a guide that explains how rustc works.
+The aim of the guide is to help new contributors get oriented to rustc,
+as well as to help more experienced folks in figuring out
 some new part of the compiler that they haven't worked on before.
 
-[You can read the latest version of the guide here.](https://rustc-dev-guide.rust-lang.org/)
+You may also find the [rustc API docs] useful.
 
-You may also find the rustdocs [for the compiler itself][rustdocs] useful.
 Note that these are not intended as a guide; it's recommended that you search
 for the docs you're looking for instead of reading them top to bottom.
 
-[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc
-
 For documentation on developing the standard library, see
 [`std-dev-guide`](https://std-dev-guide.rust-lang.org/).
 
 ### Contributing to the guide
 
 The guide is useful today, but it has a lot of work still to go.
 
-If you'd like to help improve the guide, we'd love to have you! You can find
-plenty of issues on the [issue
-tracker](https://github.com/rust-lang/rustc-dev-guide/issues). Just post a
-comment on the issue you would like to work on to make sure that we don't
-accidentally duplicate work. If you think something is missing, please open an
-issue about it!
+If you'd like to help improve the guide, we'd love to have you!
+You can find plenty of issues on the [issue
+tracker](https://github.com/rust-lang/rustc-dev-guide/issues).
+Just post a comment on the issue you would like to work on to make sure that we don't
+accidentally duplicate work.
+If you think something is missing, please open an issue about it!
 
 **In general, if you don't know how the compiler works, that is not a
 problem!** In that case, what we will do is to schedule a bit of time
 for you to talk with someone who **does** know the code, or who wants
-to pair with you and figure it out.  Then you can work on writing up
-what you learned.
+to pair with you and figure it out.
+Then you can work on writing up what you learned.
 
 In general, when writing about a particular part of the compiler's code, we
-recommend that you link to the relevant parts of the [rustc
-rustdocs][rustdocs].
+recommend that you link to the relevant parts of the [rustc API docs].
 
-The guide has a much lower bar for what it takes for a PR to be merged. Check out
-the forge documentation for [our policy][forge_policy].
+The guide has a much lower bar for what it takes for a PR to be merged.
+Check out the forge documentation for [our policy][forge_policy].
 
 [forge_policy]: https://forge.rust-lang.org/rustc-dev-guide/index.html#review-policy
 
@@ -61,9 +56,9 @@ The build files are found in the `book/html` directory.
 
 ### Link Validations
 
-We use `mdbook-linkcheck2` to validate URLs included in our documentation. Link
-checking is **not** run by default locally, though it is in CI. To enable it
-locally, set the environment variable `ENABLE_LINKCHECK=1` like in the
+We use `mdbook-linkcheck2` to validate URLs included in our documentation.
+Link checking is **not** run by default locally, though it is in CI.
+To enable it locally, set the environment variable `ENABLE_LINKCHECK=1` like in the
 following example.
 
 ```
@@ -72,6 +67,9 @@ ENABLE_LINKCHECK=1 mdbook serve
 
 ## Synchronizing josh subtree with rustc
 
-This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
+This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree.
+You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
 
 You can find a guide on how to perform the synchronization [here](./src/external-repos.md#synchronizing-a-josh-subtree).
+
+[rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle