Merge branch 'main' into rtos

Author: MabezDev

.github/workflows/ci.yml

@@ -46,4 +46,4 @@ jobs:
           target: ${{ secrets.PRODUCTION_TARGET }}
           source: "book/"
           strip_components: 1 # remove the book prefix, it's already being placed in /projects/rust/book
-          overwrite: true
+          rm: true

src/application-development/configuration.md

@@ -1,14 +1,14 @@
 # Configuration
 
-The [`esp-config`][esp-config] crate provides a way to manage additional configuration settings that don't fit into cargo features, for `esp-*` crates.
+The [`esp-config`][esp-config] crate provides a way to manage additional configuration settings that don't fit into Cargo features, for `esp-*` crates.
 
 ## Finding Available Configuration
 
-The full list of available options can be found in the [documentation] of the crate you are interested. For example, these are [esp-hal's configuration options] for the ESP32-C6.
+The full list of available options can be found in the [documentation] of the crate you are interested. For example, these are [`esp-hal`'s configuration options][esp-hal-config] for the ESP32-C6.
 
 ## Usage
 
-While creating your project, you may need to configure some additional advanced parameters, for example, place a peripheral in RAM for better performance or change the size of RX/TX queue in some crate. In order to do so you will need to configure some settings provided by the `esp-config`. 
+While creating your project, you may need to configure some additional advanced parameters, for example, place a peripheral in RAM for better performance or change the size of RX/TX queue in some crate. In order to do so you will need to configure some settings provided by the `esp-config`.
 
 You are free to do this in two ways:
 
@@ -31,7 +31,7 @@ Depending on your application, you may find yourself wanting to support differen
 
 * A baseline `.cargo/config.toml` which has your typical build modifying flags (Cargo will _always_ read and respect this file, regardless of other `--config`'s passed)
 * A config file for each configuration in `.cargo/`
-* (**Recommended**) A Cargo [alias] to build with the given config, for example `run-config-a = "run --config=./.cargo/config_a.toml --release"`, but for simple cases you can pass `--config` on the CLI. 
+* (**Recommended**) A Cargo [alias] to build with the given config, for example `run-config-a = "run --config=./.cargo/config_a.toml --release"`, but for simple cases you can pass `--config` on the CLI.
 
 Checkout [this example repo] for a more comprehensive look at multi-config projects.
 
@@ -43,6 +43,6 @@ You may also want to define certain configuration options in your project. To do
 [esp-config]: https://crates.io/crates/esp-config
 [Defining Configuration Options]: https://github.com/esp-rs/esp-hal/tree/main/esp-config#defining-configuration-options
 <!-- TODO, can we get latest to work here instead of 1.0.0-rc.0? -->
-[esp-hal's configuration options]: https://docs.espressif.com/projects/rust/esp-hal/1.0.0-rc.0/esp32c6/esp_hal/index.html#additional-configuration
+[esp-hal-config]: https://docs.espressif.com/projects/rust/esp-hal/1.0.0-rc.0/esp32c6/esp_hal/index.html#additional-configuration
 [this example repo]: https://github.com/bjoernQ/esp-hal-multiconfig-example/tree/main
-[alias]: https://doc.rust-lang.org/cargo/reference/config.html#alias
+[alias]: https://doc.rust-lang.org/cargo/reference/config.html#alias

src/application-development/ota.md

@@ -2,9 +2,8 @@
 
 Over The Air Updates (OTA), is the ability to update an application _without_ the need of production flashing tools. OTA is heavily reliant on a bootloader to handle the switching, replacement and rollback of OTA images (firmware updates). For every bootloader we support, we have a bootloader support crate, as we only support the ESP-IDF bootloader right now we only have the [`esp-bootloader-esp-idf`] crate.
 
-We have a [small OTA example] in the esp-hal repository. This example is basic, but shows the building blocks to get OTA functionality working. Be sure to check out the documentation, as this example also provides the instructions to create an OTA binary using `espflash`.
+We have a [small OTA example] in the `esp-hal` repository. This example is basic, but shows the building blocks to get OTA functionality working. Be sure to check out the documentation, as this example also provides the instructions to create an OTA binary using `espflash`.
 
 
 [`esp-bootloader-esp-idf`]: https://github.com/esp-rs/esp-hal/blob/main/esp-bootloader-esp-idf
-[docs]: https://docs.espressif.com/projects/rust/esp-bootloader-esp-idf/latest
-[small OTA example]: https://github.com/esp-rs/esp-hal/tree/main/examples/ota
+[small OTA example]: https://github.com/esp-rs/esp-hal/tree/main/examples/ota

src/assets/esp32-c6-devkitc-1-v1.2.png

@@ -4,7 +4,7 @@ We hope this book has prepared you for building real-world applications using Es
 
 We're excited to see what you create, be sure to add it to the [awesome-esp-rust] list or use this list for inspiration.
 
-If you're keen to contribute to esp-hal or the ancillary crates directly, checkout [our developer contribution documentation].
+If you're keen to contribute to `esp-hal` or the ancillary crates directly, checkout [our developer contribution documentation].
 
 
 [our developer contribution documentation]: https://github.com/esp-rs/esp-hal/tree/main/documentation

src/conclusion.md

@@ -16,7 +16,7 @@ We won't go into the details or differences between the two architectures here.
 
 Feel free to refer to the [Technical Documentation][espressif-docs] for more information about the different SoCs.
 
-> ⚠️ **Note**:  The ESP8266 is not supported by esp-hal.
+> ⚠️ **Note**:  The ESP8266 is not supported by `esp-hal`.
 >
 > However, the ESP32-C2 (ESP8684) and ESP32-C3 (ESP8685) are supported. Notably, the ESP32-C3 is pin-compatible with the ESP8266, making it a suitable drop-in replacement.