Overhaul pt1: Intro, overview and installation #84
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
* Remove the "Resources" and "Glossary" pages * Rewrite most of the introduction chapter * Address review comments
* docs: 📝 Initial rework of installation chapter * docs: 📝 Add build diagram * docs: 📝 Update riscv section * docs: 📝 Update riscv section * docs: 📝 Update Xtensa section * chore: 🔥 Remove build process * style: 🎨 Format troubleshooting chapter * docs: 📝 Update export paths * docs: 📝 Update libtinfo5 error * docs: 📝 Fix typos * fix: 🐛 Fix tests * fix: 🐛 Fix link * fix: 🐛 Fix link * docs: 🐛 Fix note on `no_std` targets * chore: ⚡️ Minor updates to simplify instructions * docs: Fix typo Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com> * docs: Fix typo Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com> * docs: Update insallation methods order Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com> * docs: 📝 Address comments * docs: 📝 Address comments * docs: 📝 Update default no_std riscv target --------- Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com>
* Update index.md Restructure the chapter Setting Up the Development Environment * Update according to comments from Sergio * Update src/installation/index.md * Update src/installation/index.md * Update src/installation/index.md * Update index.md * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update index.md * Update RISC-V and Xtensa targets section names * Update link variable names * Update src/installation/index.md * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Updates links to alternative espup installation * Update the line on sourcing files on Windows * Remove new line that breaks the note in mdbook * Fix typo * Update src/installation/index.md * Update src/installation/index.md * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Indent the note under 2. Wndows * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Swap Section What espup Installs with Other installation methods * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Add missing cargo install ldproxy command * Apply suggestions from Dominik Co-authored-by: Dominik Gschwind <dominik.gschwind99@gmail.com> * Update the line about the GCC toolchain * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Replace Xtensa targets with Espressif targets * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update the link formatting --------- Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> Co-authored-by: Dominik Gschwind <dominik.gschwind99@gmail.com>
* Update index.md Restructure the chapter Setting Up the Development Environment * Update according to comments from Sergio * Update src/installation/index.md * Update src/installation/index.md * Update src/installation/index.md * Update index.md * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/installation/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Apply suggestions from code review Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update index.md * Update RISC-V and Xtensa targets section names * Update link variable names * Update index.md * Update comparing-std-and-no_std * Update using-the-standard-library * Update bare-metal * Update table alignment * Update alignment * Restore installation/intex.md to its pre-fork state * Fix title syntax * Update src/overview/bare-metal.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/bare-metal.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/bare-metal.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/bare-metal.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/using-the-standard-library.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Update src/overview/comparing-std-and-no_std.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Implement comments for Sergio * Add a link to ESP8266 HAL * Add the newlib link * Update src/overview/using-the-standard-library.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Add link to esp-idf-release-compatibility table * Add link to esp-idf-release-compatibility table * Update sentence with link to esp-idf compatibility * Delete duplicate link definition * Add intro paragraph to std vs no_std * Remove the intro to esp-idf-svc * Remove Section Software Stacks * Add the table legend * Fix link issue * Update src/overview/comparing-std-and-no_std.md * Move FAQ to Troubleshooting * Add FAQ content * Update table covering no_std crates * Update link to ESP8266 HAL * Update src/overview/index.md Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * fix: ⚡️ Update no_std support table * refactor: ♻️ Move comparison to index * fix: 🐛 Fix link * Improve the formatting of a list * Remove the symbol column * feat: 🎨 Update support tables * FIx markdown note formatting issue Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix formatting for a ref to another section Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Add monospace font to terms Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix a typo Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix a typo Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix a typo Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix a typo Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Include section on bare metal from Jurajs blogpost Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Include section on standard library from Jurajs blogpost Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix a typo Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com> * Fix typos * Update ESP32-H2 curent support --------- Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com>
jessebraham
reviewed
Apr 28, 2023
| > - ESP32 S-Series | ||
| > | ||
| > The ESP8266 series is outside the scope of this book. Rust support for the | ||
| > ESP8266 series is limited and is not being officially supported by Espressif. |
There was a problem hiding this comment.
The A note in SoCs support and A Note on Device Support blockquotes here seem to be trying to say the same thing, as far as I can tell?
There was a problem hiding this comment.
Good catch! Just fixed it in 02eb301 and added the ESP32 H-Series since we mention it in other parts of the book
jessebraham
approved these changes
May 2, 2023
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.
No description provided.