Skip to content

Commit e9685d6

Browse files
authored
Merge pull request #208 from rust-lang-nursery/readme
Update a few parts of the readme
2 parents ceff08f + 7cf032f commit e9685d6

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

Diff for: README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,26 @@ You may also find the rustdocs [for the compiler itself][rustdocs] useful.
1010
[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
1111

1212
The guide can be useful today, but it has a lot of work still go.
13-
Once it gets more complete, the plan is probably to move it into the
14-
[main Rust repository](https://github.com/rust-lang/rust/).
1513

1614
### Contributing to the guide
1715

18-
If you'd like to help finish the guide, we'd love to have you! The
19-
main tracking issue for the guide
20-
[can be found here](https://github.com/rust-lang-nursery/rustc-guide/issues/6). From
21-
there, you can find a list of all the planned chapters and subsections.
22-
If you think something is missing, please open an issue about it!
23-
Otherwise, find a chapter that sounds interesting to you and then go
24-
to its associated issue. There should be a list of things to do.
16+
If you'd like to help improve the guide, we'd love to have you! You can find
17+
plenty of issues on the [issue
18+
tracker](https://github.com/rust-lang-nursery/rustc-guide/issue). Just post a
19+
comment on the issue you would like to work on to make sure that we don't
20+
accidentally duplicate work. If you think something is missing, please open an
21+
issue about it!
2522

2623
**In general, if you don't know how the compiler works, that is not a
2724
problem!** In that case, what we will do is to schedule a bit of time
2825
for you to talk with someone who **does** know the code, or who wants
2926
to pair with you and figure it out. Then you can work on writing up
3027
what you learned.
3128

29+
In general, when writing about a particular part of the compiler's code, we
30+
recommend that you link to the relevant parts of the [rustc
31+
rustdocs][rustdocs].
32+
3233
To help prevent accidentally introducing broken links, we use the
3334
`mdbook-linkcheck`. If installed on your machine `mdbook` will automatically
3435
invoke this link checker, otherwise it will emit a warning saying it couldn't

0 commit comments

Comments
 (0)