Skip to content

Commit ae4b550

Browse files
committed
add an "about this guide" section
1 parent 66973d5 commit ae4b550

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Summary
22

3+
- [About this guide](./chap-000-about-this-guide.md)
34
- [How to build the compiler and run what you built](./chap-010-how-to-build-and-run.md)
45
- [Using the compiler testing framework](./chap-020-running-tests.md)
56
- [Walkthrough: a typical contribution](./chap-030-walkthrough.md)

src/chap-000-about-this-guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# About this guide
2+
3+
This guide is meant to help document how rustc -- the Rust compiler --
4+
works, as well as to help new contributors get involved in rustc
5+
development. It is not meant to replace code documentation -- each
6+
chapter gives only high-level details, the kinds of things that
7+
(ideally) don't change frequently.
8+
9+
The guide itself is of course open source as well, and the sources can
10+
be found at [the GitHub repository]. If you find any mistakes in the
11+
guide, please file an issue about it -- or, even better, open a PR
12+
with a correction!
13+
14+
[the GitHub repository]: https://github.com/rust-lang-nursery/rustc-guide/

0 commit comments

Comments
 (0)