Skip to content

Mention discovery book more prominently #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jan 27, 2020
Merged

Mention discovery book more prominently #219

merged 1 commit into from
Jan 27, 2020
+1 −0

Conversation

phansch
Copy link
Contributor

@phansch phansch commented Jan 6, 2020

Hi, I just started reading the book and only by chance found the discovery book via the bookshelf.

I think it's worth mentioning it explicitly somewhere on this page for people who are not familiar with embedded development.

@phansch phansch requested a review from a team as a code owner January 6, 2020 06:44
@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @thejpster (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources labels Jan 6, 2020
@phansch
Copy link
Contributor Author

phansch commented Jan 6, 2020

I was also thinking of mentioning the discovery book directly in the first paragraph on the page to redirect beginners immediately, but I'm not sure if that's too much?

My understanding of the target audiences of the various books currently is:

  1. Discovery book for embedded programming beginners
  2. This book for people with embedded experience
  3. The embeddonomicon for more advanced things

@thejpster
Copy link
Contributor

bors r+

@thejpster
Copy link
Contributor

Thanks for the PR. I agree, the extra pointer to the beginners book will be useful for some.

bors bot added a commit that referenced this pull request Jan 27, 2020
@bors @phansch
Merge #219
0a6af4d 
219: Mention discovery book more prominently r=thejpster a=phansch

Hi, I just started reading the book and only by chance found the discovery book via the bookshelf.

I think it's worth mentioning it explicitly somewhere on this page for people who are not familiar with embedded development.

Co-authored-by: Philipp Hansch <dev@phansch.net>
@bors
Copy link
Contributor

bors bot commented Jan 27, 2020

Build succeeded

@bors bors bot merged commit 9070d63 into rust-embedded:master Jan 27, 2020
@phansch phansch deleted the mention_discovery branch February 1, 2020 08:27
@ehuss ehuss mentioned this pull request Feb 12, 2020
Merged
bors added a commit to rust-lang/rust that referenced this pull request Feb 14, 2020
@bors
Auto merge of #69115 - ehuss:update-books, r=Dylan-DPC
433aae9 
Update books.

This required some changes in how the books are tested due to some changes in rust-lang/book.  It uses new syntax that is not compatible with bare `rustdoc --test`.  This changes it so that it uses rustbook to run the tests, which is essentially the same as `mdbook test`.

## reference

7 commits in 11e893f..64239df
2020-01-18 21:24:08 +0100 to 2020-02-10 19:05:13 +0100
- Update for nested receivers. (rust-lang/reference#724)
- clarify note re. leading `::` in 2018 (rust-lang/reference#752)
- Update macro-ambiguity.md (rust-lang/reference#754)
- typo fix: add missing `by` (rust-lang/reference#753)
- fix `TypeParamBounds` link on trait objects (rust-lang/reference#749)
- reorganize docs on references (rust-lang/reference#745)
- add MacroRepOp usage for ? (rust-lang/reference#744)

## book

49 commits in 87dd6843678575f8dda962f239d14ef4be14b352..6fb3705e5230311b096d47f7e2c91f9ce24393d0
2020-01-20 15:20:40 -0500 to 2020-02-12 13:48:57 -0500
- Fix nomicon links. (rust-lang/book#2253)
- Update to Rust 1.41.0 (rust-lang/book#2244)
- Listing 19-6: use ptr.add instead of ptr.offset (rust-lang/book#2201)
- Remove unneeded mutable reference
- Clarify deref coercion explanation
- Fix typo in link to 1.30 book
- Acknowledge Murphy's Law
- Clarify that buffer overread is UB in C
- Change from "must" to "idiomatic" about comments
- Fancy quotes
- Make HashMap types match previous example; add fwd ref to ch 13
- Tweak wording to array clarification
- Merge remote-tracking branch 'origin/pr/2236'
- Update all our crates (rust-lang/book#2235)
- Reword git caveat
- Merge remote-tracking branch 'origin/pr/2234'
- Merge remote-tracking branch 'origin/pr/2230'
- println! is a macro (rust-lang/book#2224)
- Update a translated version link (rust-lang/book#2221)
- move `Macro invocation` from section on tuple to section on mac… (rust-lang/book#2206)
- Do not limit `Self` usage in trait implementation (rust-lang/book#2197)
- Merge remote-tracking branch 'origin/pr/2191'
- Fix wrapping
- Merge remote-tracking branch 'origin/pr/2187'
- Updated appendix 07 to reflect deprecation of rustup install (rust-lang/book#2181)
- Make links to the Nomicon consistent
- Merge remote-tracking branch 'origin/pr/2180'
- Merge remote-tracking branch 'origin/pr/2175'
- Merge remote-tracking branch 'origin/pr/2171'
- Merge remote-tracking branch 'origin/pr/2170'
- Clarify and make consistent the explanation of unions
- Merge remote-tracking branch 'origin/pr/2166'
- Handle dev or test in the Finished output line
- Link to macros by example rather than macros (rust-lang/book#2164)
- Merge remote-tracking branch 'origin/pr/2147'
- Fix parens (rust-lang/book#2132)
- Clarify type inference with closures requires calling the closures
- Update link to French translation (rust-lang/book#2119)
- Merge remote-tracking branch 'origin/pr/2108'
- Add an explicit cross reference to data type
- Merge remote-tracking branch 'origin/pr/2105'
- ch15-02-deref: Improve explanation on immut-to-mut (rust-lang/book#2030)
- Remove unnecessary quotes
- Make markdown link identifier match
- Remove extra newline
- Merge remote-tracking branch 'origin/pr/2004'
- Extract code and output; script formatting and updating them (rust-lang/book#2231)
- Switch "Finally" to "Next" to reflect new chapters having been… (rust-lang/book#2098)
- ch19-06 added curly braces to macro output (rust-lang/book#2050)

## rust-by-example

2 commits in 1c2bd024d13f8011307e13386cf1fea2180352b5..32facd5522ddbbf37baf01e4e4b6562bc55c071a
2020-01-20 12:18:36 -0300 to 2020-02-11 09:25:06 -0300
- Add missing `dyn` in code sample (rust-lang/rust-by-example#1306)
- Improve grammar in a few sections (rust-lang/rust-by-example#1305)

## edition-guide

1 commits in 1a2390247ad6d08160e0dd74f40a01a9578659c2..37f9e6848411188a1062ead1bd8ebe4b8aa16899
2019-12-29 10:40:55 -0800 to 2020-02-10 14:36:14 +0100
- Fixed typo (rust-lang/edition-guide#196)

## embedded-book

4 commits in 4d78994915af1bde9a95c04a8c27d8dca066232a..b2e1092bf67bd4d7686c4553f186edbb7f5f92db
2020-01-14 08:25:25 +0000 to 2020-01-30 08:45:46 +0000
- Make typestate initialization notes correct  (rust-embedded/book#224)
- Mention discovery book more prominently  (rust-embedded/book#219)
- Replace nursery links with rust-lang links  (rust-embedded/book#222)
- Add a Glossary appendix page  (rust-embedded/book#223)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thejpster thejpster thejpster approved these changes

Assignees

@thejpster thejpster

Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@phansch @rust-highfive @thejpster