Improve Introduction #408
Merged
Improve Introduction #408
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Havvy
force-pushed
the
rustconf-rustfest
branch
from
0c4db03 to
4abeeb9
Compare
matthewjasper
requested changes
Aug 25, 2018
src/introduction.md
Outdated
| ``` | ||
|
|
||
| * The grammar and lexical structure is in blockquotes with either "Lexer" or | ||
| "Syntax" in **bold** as the first line in <sup>superscript</sup>. |
There was a problem hiding this comment.
Should this be "in bold superscript..."
src/introduction.md
Outdated
|
|
||
| * Notes that contain useful information about the state of the book or point out | ||
| useful, but mostly out of scope, information are in blockquotes that start with | ||
| the word "Note:" in **bold**. |
There was a problem hiding this comment.
The example doesn't match this.
src/introduction.md
Outdated
| <div class="warning"> | ||
|
|
||
| Warning: This book is incomplete. Documenting everything takes a | ||
| while. We have a [big issue] to track documentation for every Rust feature, |
There was a problem hiding this comment.
This issue was closed and replaced with smaller issues.
|
All addressed. |
matthewjasper
approved these changes
Aug 25, 2018
Havvy
added
the
Language Cleanup
JoshBrudnak
reviewed
Sep 1, 2018
| [linkage]: linkage.html | ||
| [rustc book]: ../rustc/index.html | ||
| [undocumented]: undocumeted.html |
There was a problem hiding this comment.
It might be helpful to add a link to the Rustonomicon.
* 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.
This involved moving paragraphs around as well.
Havvy
force-pushed
the
rustconf-rustfest
branch
from
e4aa57c to
0d7a062
Compare
steveklabnik
suggested changes
Sep 5, 2018
src/introduction.md
Outdated
| Rust. For unstable features being worked on, see the [Unstable Book]. This was | ||
| a recent change in scope, so unstable features are still documented, but are | ||
| in the process of being removed. | ||
| Similarly, this book does not usually book the specifics of `rustc` as a |
There was a problem hiding this comment.
the second 'book' here should be 'document'
steveklabnik
approved these changes
Sep 7, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #406
I totes stole the section title "How to Use This Book" from TRPL. ❤️
This PR will be easier to read by the individual commit.
Due to rendering being important, I have updated my website to render to this commit. Rendered!