Fix readmes links (#805)

* docs: Add missing link

* docs: Fix links

* docs: Update docstrings

* docs: fix typo

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

* docs: Update docstrings

* docs: Udpate usage

---------

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

Author: SergioGasquez

cargo-espflash/Cargo.toml

@@ -3,7 +3,7 @@ name         = "cargo-espflash"
 version      = "4.0.0-dev"
 edition      = "2021"
 rust-version = "1.82"
-description  = "Cargo subcommand for flashing Espressif devices"
+description  = "Cargo subcommand for interacting with Espressif devices"
 repository   = "https://github.com/esp-rs/espflash"
 license      = "MIT OR Apache-2.0"
 

cargo-espflash/README.md

@@ -52,7 +52,7 @@ OPENSSL_NO_VENDOR=1 cargo install cargo-espflash
 ## Usage
 
 ```text
-Cargo subcommand for flashing Espressif devices
+Cargo subcommand for interacting with Espressif devices
 
 Usage: cargo espflash [OPTIONS] <COMMAND>
 
@@ -65,7 +65,7 @@ Commands:
   erase-region     Erase specified region
   flash            Flash an application in ELF format to a target device
   hold-in-reset    Hold the target device in reset
-  list-ports       List serial ports available for flashing
+  list-ports       List available serial ports
   monitor          Open the serial monitor without flashing the connected target device
   partition-table  Convert partition tables between CSV and binary format
   read-flash       Read SPI flash content
@@ -176,8 +176,9 @@ You can have a local and/or a global configuration file:
   - See [`defmt` section] of `esp-println` readme.
   - For a detailed guide on how to use `defmt` in the `no_std` ecosystem, see [`defmt` project] of Embedded Rust (no_std) on Espressif book.
 
-[`defmt` section]: https://github.com/esp-rs/esp-println?tab=readme-ov-file#defmt
-[`defmt` project]: https://esp-rs.github.io/no_std-training/03_6_defmt.html
+[`defmt`]: https://defmt.ferrous-systems.com/
+[`defmt` section]: https://github.com/esp-rs/esp-hal/tree/main/esp-println#defmt
+[`defmt` project]: https://docs.esp-rs.org/no_std-training/03_7_defmt.html
 
 ## License
 

cargo-espflash/src/main.rs

@@ -88,7 +88,7 @@ enum Commands {
     Flash(FlashArgs),
     /// Hold the target device in reset
     HoldInReset(ConnectArgs),
-    /// List serial ports available for flashing.
+    /// List available serial ports.
     ///
     /// The default behavior is to only list ports of devices known to be used
     /// on development boards.

espflash/Cargo.toml

@@ -3,7 +3,7 @@ name         = "espflash"
 version      = "4.0.0-dev"
 edition      = "2021"
 rust-version = "1.82"
-description  = "A command-line tool for flashing Espressif devices"
+description  = "A command-line tool for interacting with Espressif devices"
 repository   = "https://github.com/esp-rs/espflash"
 license      = "MIT OR Apache-2.0"
 keywords     = ["cli", "embedded", "esp"]

espflash/README.md

@@ -47,7 +47,7 @@ cargo binstall espflash
 ## Usage
 
 ```text
-A command-line tool for flashing Espressif devices
+A command-line tool for interacting with Espressif devices
 
 Usage: espflash [OPTIONS] <COMMAND>
 
@@ -60,7 +60,7 @@ Commands:
   erase-region     Erase specified region
   flash            Flash an application in ELF format to a connected target device
   hold-in-reset    Hold the target device in reset
-  list-ports       List serial ports available for flashing
+  list-ports       List available serial ports
   monitor          Open the serial monitor without flashing the connected target device
   partition-table  Convert partition tables between CSV and binary format
   read-flash       Read SPI flash content
@@ -120,7 +120,7 @@ With this configuration you can flash and monitor you application using `cargo r
 `espflash` can be used as a library in other applications:
 
 ```toml
-espflash = { version = "2.1", default-features = false }
+espflash = { version = "3.3", default-features = false }
 ```
 
 or `cargo add espflash --no-default-features`
@@ -189,8 +189,9 @@ You can have a local and/or a global configuration file:
   - See [`defmt` section] of `esp-println` readme.
   - For a detailed guide on how to use `defmt` in the `no_std` ecosystem, see [`defmt` project] of Embedded Rust (no_std) on Espressif book.
 
-[`defmt` section]: https://github.com/esp-rs/esp-println?tab=readme-ov-file#defmt
-[`defmt` project]: https://esp-rs.github.io/no_std-training/03_6_defmt.html
+[`defmt`]: https://defmt.ferrous-systems.com/
+[`defmt` section]: https://github.com/esp-rs/esp-hal/tree/main/esp-println#defmt
+[`defmt` project]: https://docs.esp-rs.org/no_std-training/03_7_defmt.html
 
 ## License
 

espflash/src/bin/espflash.rs

@@ -59,7 +59,7 @@ enum Commands {
     Flash(FlashArgs),
     /// Hold the target device in reset
     HoldInReset(ConnectArgs),
-    /// List serial ports available for flashing.
+    /// List available serial ports.
     ///
     /// The default behavior is to only list ports of devices known to be used
     /// on development boards.