Skip to content

Commit edf6c62

Browse files
committed
Expand the introduction.
* Added another paragraph explaining that we don't document tools. * Expanded the contribution section. * Remove the part saying we may document some unstable stuff. * Added a how-to-read paragraph.
1 parent dc56e79 commit edf6c62

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

src/introduction.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,54 @@ This document does not serve as an introduction to the language. Background
1313
familiarity with the language is assumed. A separate [book] is available to
1414
help acquire such background familiarity.
1515

16-
This document also does not serve as a reference to the [standard] library
16+
This document also does not serve as a reference to the [standard library]
1717
included in the language distribution. Those libraries are documented
1818
separately by extracting documentation attributes from their source code. Many
1919
of the features that one might expect to be language features are library
2020
features in Rust, so what you're looking for may be there, not here.
2121

22+
Similarly, this document does not usually document the specifics of `rustc` as a
23+
tool or of Cargo. Cargo has a [book][cargo book] that contains a
24+
[reference][cargo reference]. There are a few pages such as [linkage] that still
25+
describe how `rustc` works.
26+
2227
This document also only serves as a reference to what is available in stable
23-
Rust. For unstable features being worked on, see the [Unstable Book]. This was
24-
a recent change in scope, so unstable features are still documented, but are
25-
in the process of being removed.
28+
Rust. For unstable features being worked on, see the [Unstable Book].
2629

2730
Finally, this document is not normative. It may include details that are
2831
specific to `rustc` itself, and should not be taken as a specification for
29-
the Rust language. We intend to produce such a document someday, but this
30-
is what we have for now.
32+
the Rust language. We intend to produce such a document someday, and until then,
33+
the reference is the closest thing we have to one.
34+
35+
You sould not read this document sequentially. As a reference document, you
36+
should skim the table of contents until you find the section you are interested
37+
in and read that section. If you are viewing this in a browser and have
38+
JavaScript enabled, you can also press `s` or click the magnifying glass on the
39+
top bar to open a search bar.
3140

3241
You may also be interested in the [grammar].
3342

3443
You can contribute to this document by opening an issue or sending a pull
35-
request to [the Rust Reference repository].
44+
request to [the Rust Reference repository]. If this document does not answer
45+
your question, and you think its answer is in scope of it, please do not
46+
hesitate to file an issue or ask about it in the Rust docs channels on IRC or
47+
discord. Knowing what people use this document for the most helps direct our
48+
attention to making those sections the best that they can be.
3649

37-
N. B. This document may be incomplete. Documenting everything might take a
50+
<div class="warning">
51+
52+
Warning: This document may be incomplete. Documenting everything takes a
3853
while. We have a [big issue] to track documentation for every Rust feature,
3954
so check that out if you can't find something here.
4055

56+
</div>
57+
4158
[book]: ../book/index.html
42-
[standard]: ../std/index.html
59+
[standard library]: ../std/index.html
4360
[grammar]: ../grammar.html
4461
[the Rust Reference repository]: https://github.com/rust-lang-nursery/reference/
4562
[big issue]: https://github.com/rust-lang-nursery/reference/issues/9
46-
[Unstable Book]: https://doc.rust-lang.org/nightly/unstable-book/
63+
[Unstable Book]: https://doc.rust-lang.org/nightly/unstable-book/
64+
[cargo book]: ../cargo/index.html
65+
[cargo reference]: ../cargo/reference/index.html
66+
[linkage]: linkage.html

0 commit comments

Comments
 (0)