Skip to content

Conversation

@MabezDev
Copy link
Member

A huge thank you for all the contributions! 🎉 ❤️

I think we're in much better shape, and we're in a position to improve this book as time goes on.

Closes https://github.com/esp-rs/book/milestone/2

jessebraham and others added 30 commits September 22, 2025 12:44
* docs: Update getting started chapter

* feat: Review comments

* style: Avoid monospace in Xtensa and RISC-V

* docs: Update guidelines

* docs: Review comments

* docs: Remove dubbing section

* docs: Add note for chips without usb-serial-jtag

* fix: Name of the document
* docs: Initial changes to the intro chapter

* docs: Review comments

* docs: Remove MCUboot section

* docs: Add a small section about peripheral ref

* docs: Address review comments

* docs: Add link to espup section note
* docs: FAQ section

* docs: Fix qemu supported targets

* docs: Address review comments

* fix: Broken link

* docs: Fix cargo targets for RA settings
* Writing your own application

* Mention alloc and review comments

* reviews

* another review

* another reviews

* Apply suggestions from code review

Co-authored-by: Jesse Braham <[email protected]>
Co-authored-by: Sergio Gasquez Arcos <[email protected]>

* another review

* Add PSRAM section and reviews

* Apply suggestions from code review

Co-authored-by: Dániel Buga <[email protected]>

* Mention atomics and PSRAM limitation and address comments

---------

Co-authored-by: Jesse Braham <[email protected]>
Co-authored-by: Sergio Gasquez Arcos <[email protected]>
Co-authored-by: Dániel Buga <[email protected]>
* docs: Fix typos

* docs: Clarify second stage bootloader(s) and partition table details

* docs: Remove unused links

* docs: Remove scripts installation method

* docs: Fix typos and improve cargo run explanation

* docs: Remove `vendored-openssl` note

* docs: Fix typos and format
* docs: Improve note on ESP8266

* docs: Explain why Xtensa is not supported in Rust upfront

* docs: Remove `Peripheral` pattern section

* docs: Simplify sourcing of file, defer to espup readme (Pending on esp-rs/espup#499)

* docs: Clarify tooling summary

* docs: Update terminology for what `esp-generate` does

* docs: Avoid using TUI term

* docs: Avoid explaining the generated files

* docs: Reviews comments

* docs: Add missing links
* ci: Add vale checks

* ci: Test vale action

* ci: Update rules

* feat: Update rules and format

* feat: Udpate .gitignore

* feat: Add Rust pacakge

* docs: Fix vale errors
Co-authored-by: Sergio Gasquez Arcos <[email protected]>
* feat: Delete app start workflow

* feat: Add anciliary crates

* feat: Add devkit explanation

* fix: Vale errors

* feat: Add allowed acronyms

* fix: Allow case-insensitive 'NOW'

* feat: Add esp-rom-sys

* feat: Rework intro

* feat: Rename to esp-radio and point to the peripheral support table

* fead: Address review comments
* Rework `Getting Started` chapter

* Backticks

* Mention esp-generate's full interactive mode

* Rephrasing

* Address review comments

* Fix link

* Remove the fluff from "using esp-generate"

* Simplify toolchain-installation (somewhat)

* Add esp-config, clarifications
* expands in some places in certain sections
* adds OTA section
* adds conclusion
* reword to have consistent voice throughout the book
* remove some AI-isms in the writing style
@MabezDev MabezDev force-pushed the esp-hal@1 branch 2 times, most recently from e9ec0e5 to 338c747 Compare September 22, 2025 11:54
@MabezDev MabezDev merged commit 0e0c54d into main Sep 22, 2025
3 checks passed
@MabezDev MabezDev deleted the esp-hal@1 branch September 22, 2025 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants