[doc/book] Add introduction page and other enhancements #4455
Conversation
This file contains 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
Import install text and links from <https://crates.io/install>, as we want to drop that page and redirect it to here. See <rust-lang/crates.io#1029>
|
@bors: r+ |
|
📌 Commit 2ad45a5 has been approved by |
|
⌛ Testing commit 2ad45a5 with merge 55695e53e53584efa8f8acbbd399826199242624... |
|
💔 Test failed - status-travis |
|
This is so awesome, thank you so much for working on this stuff! |
|
@bors: retry
…On Fri, Sep 1, 2017 at 11:25 AM, Steve Klabnik ***@***.***> wrote:
This is so awesome, thank you so much for working on this stuff!
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
<#4455 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAD95PWvWo-7SD8AF-PX0D5ANLipjspfks5seC_tgaJpZM4PJdgT>
.
|
bors
added a commit
that referenced
this pull request
Sep 1, 2017
[doc/book] Add introduction page and other enhancements Preview: http://code.behnam.es/rust-cargo/book/ * Reorganize files to use folders instead of numbered files. This will allow us to add new sections and pages without breaking a numbering system or the URLs. * Rename "Cargo In Depth" to "Cargo Reference", as those pages are considered *the* reference for cargo behaviors. * Add `introduction.md`, as the landing page with the book title and Cargo logo on top. * Expand `installation.md`: Import install text and links from <https://crates.io/install>, as we want to drop that page and redirect it to here. (See <rust-lang/crates.io#1029>) * Sync `SUMMARY.md` titles (and sub-pages lists in section pages) with page titles and fix some wordings and casings. * Expand Introduction and section pages with some intro text. * Set lang for some of the code blocks. * Add `book.toml` to get the title in HTML head title, etc. Tracker: <#4040>
|
☀️ Test successful - status-appveyor, status-travis |
wking
added a commit
to wking/cargo
that referenced
this pull request
Jan 8, 2018
This had been added to the non-book docs in 2ad45a5 ([doc] Sync back doc/book changes into old docs, 2017-08-31, rust-lang#4455), despite the fact that the book didn't actually have that marker: $ git cat-file -p 2ad45a5:src/doc/book/src/guide/dependencies.md | grep -A2 'You can now use the' You can now use the `regex` library using `extern crate` in `main.rs`. ```
wking
added a commit
to wking/cargo
that referenced
this pull request
Jan 8, 2018
This wording was originally from 58a1804 (At the end, point to docs that might be interesting next, 2016-05-17, rust-lang#2688), which added it to the end of the guide (where telling readers what they know makes some sense). It was moved to a "Cargo in Depth" section with 01aa9e3 ([src/doc/book] Move a paragraph to cargo-in-depth.md, 2017-08-31, rust-lang#4453), where it makes a bit less sense. When that section became the reference index in 3f2d93e ([doc/book] Create dir for book sections, 2017-08-31, rust-lang#4455) the context assumed by the paragraph was completely missing. This commit removes the paragraph, which doesn't reduce the usefulness of the reference index. And the removal avoids confusing readers who start with the reference docs and may now have the assumed overview.
bors
added a commit
that referenced
this pull request
Jan 8, 2018
…lexcrichton doc/reference/index: Remove "Now that you have an overview" paragraph This wording was originally from 58a1804 (#2688), which added it to the end of the guide (where telling readers what they know makes some sense). It was moved to a "Cargo in Depth" section with 01aa9e3 (#4453), where it makes a bit less sense. When that section became the reference index in 3f2d93e (#4455) the context assumed by the paragraph was completely missing. This commit removes the paragraph, which doesn't reduce the usefulness of the reference index. And the removal avoids confusing readers who start with the reference docs and may now have the assumed overview.
bors
added a commit
that referenced
this pull request
Jan 9, 2018
doc/guide/dependencies: Add a 'rust' language marker This had been added to the non-book docs in 2ad45a5 (#4455), despite the fact that the book didn't actually have that marker: $ git cat-file -p 2ad45a5:src/doc/book/src/guide/dependencies.md | grep -A2 'You can now use the' You can now use the `regex` library using `extern crate` in `main.rs`. ``` This is (along with the already-landed #4916), part of recovering from #4904.
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.
Preview: http://code.behnam.es/rust-cargo/book/
Reorganize files to use folders instead of numbered files. This will allow us to add new sections and pages without breaking a numbering system or the URLs.
Rename "Cargo In Depth" to "Cargo Reference", as those pages are considered the reference for cargo behaviors.
Add
introduction.md, as the landing page with the book title and Cargo logo on top.Expand
installation.md: Import install text and links from https://crates.io/install, as wewant to drop that page and redirect it to here. (See Merge https://crates.io/install into http://doc.crates.io/#installing crates.io#1029)
Sync
SUMMARY.mdtitles (and sub-pages lists in section pages) with page titles and fix some wordings and casings.Expand Introduction and section pages with some intro text.
Set lang for some of the code blocks.
Add
book.tomlto get the title in HTML head title, etc.Tracker: #4040