diff options
| author | Niko Matsakis <niko@alum.mit.edu> | 2018-01-19 06:38:33 -0500 |
|---|---|---|
| committer | Niko Matsakis <niko@alum.mit.edu> | 2018-01-19 06:39:09 -0500 |
| commit | 02d40b33f487de79111d2851d4cd1ffe6682226f (patch) | |
| tree | 8d14c392be5b215c49164e76b2e02fc58f2bb15b /src/doc/rustc-dev-guide | |
| parent | fff09873da28e9618cef0dbea70e6e0a9e0415f9 (diff) | |
| download | rust-02d40b33f487de79111d2851d4cd1ffe6682226f.tar.gz rust-02d40b33f487de79111d2851d4cd1ffe6682226f.zip | |
add an "about this guide" section
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/chap-000-about-this-guide.md | 14 |
2 files changed, 15 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md index 21c87188555..30dde6fb978 100644 --- a/src/doc/rustc-dev-guide/src/SUMMARY.md +++ b/src/doc/rustc-dev-guide/src/SUMMARY.md @@ -1,5 +1,6 @@ # Summary +- [About this guide](./chap-000-about-this-guide.md) - [How to build the compiler and run what you built](./chap-010-how-to-build-and-run.md) - [Using the compiler testing framework](./chap-020-running-tests.md) - [Walkthrough: a typical contribution](./chap-030-walkthrough.md) diff --git a/src/doc/rustc-dev-guide/src/chap-000-about-this-guide.md b/src/doc/rustc-dev-guide/src/chap-000-about-this-guide.md new file mode 100644 index 00000000000..ea840177b55 --- /dev/null +++ b/src/doc/rustc-dev-guide/src/chap-000-about-this-guide.md @@ -0,0 +1,14 @@ +# About this guide + +This guide is meant to help document how rustc -- the Rust compiler -- +works, as well as to help new contributors get involved in rustc +development. It is not meant to replace code documentation -- each +chapter gives only high-level details, the kinds of things that +(ideally) don't change frequently. + +The guide itself is of course open source as well, and the sources can +be found at [the GitHub repository]. If you find any mistakes in the +guide, please file an issue about it -- or, even better, open a PR +with a correction! + +[the GitHub repository]: https://github.com/rust-lang-nursery/rustc-guide/ |
