Skip to content

Commit 9d4b36d

Browse files
committed
Add structure (headers) to introduction
This involved moving paragraphs around as well.
1 parent edf6c62 commit 9d4b36d

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

src/introduction.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ provides three kinds of material:
99
- Appendix chapters providing rationale and references to languages that
1010
influenced the design.
1111

12+
You may also be interested in the [grammar].
13+
14+
<div class="warning">
15+
16+
Warning: This document is incomplete. Documenting everything takes a
17+
while. We have a [big issue] to track documentation for every Rust feature,
18+
so check that out if you can't find something here.
19+
20+
</div>
21+
22+
## What *The Reference* is Not
23+
1224
This document does not serve as an introduction to the language. Background
1325
familiarity with the language is assumed. A separate [book] is available to
1426
help acquire such background familiarity.
@@ -32,13 +44,17 @@ specific to `rustc` itself, and should not be taken as a specification for
3244
the Rust language. We intend to produce such a document someday, and until then,
3345
the reference is the closest thing we have to one.
3446

47+
## How to Read The Reference
48+
3549
You sould not read this document sequentially. As a reference document, you
3650
should skim the table of contents until you find the section you are interested
3751
in and read that section. If you are viewing this in a browser and have
3852
JavaScript enabled, you can also press `s` or click the magnifying glass on the
3953
top bar to open a search bar.
4054

41-
You may also be interested in the [grammar].
55+
## Contributing
56+
57+
We welcome contributions of all kind.
4258

4359
You can contribute to this document by opening an issue or sending a pull
4460
request to [the Rust Reference repository]. If this document does not answer
@@ -47,14 +63,6 @@ hesitate to file an issue or ask about it in the Rust docs channels on IRC or
4763
discord. Knowing what people use this document for the most helps direct our
4864
attention to making those sections the best that they can be.
4965

50-
<div class="warning">
51-
52-
Warning: This document may be incomplete. Documenting everything takes a
53-
while. We have a [big issue] to track documentation for every Rust feature,
54-
so check that out if you can't find something here.
55-
56-
</div>
57-
5866
[book]: ../book/index.html
5967
[standard library]: ../std/index.html
6068
[grammar]: ../grammar.html

0 commit comments

Comments
 (0)