diff options
| author | James Munns <[email protected]> | 2024-07-22 11:48:12 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-07-22 11:48:12 +0000 |
| commit | ea4c2ca95d640e09da13d6ffab51ec943d3fc667 (patch) | |
| tree | dd4e7b0e8c2606cb42a4e1d99494842d43077e30 /docs/pages | |
| parent | 2766993099b6604739ae25724aa2f6a9877d9902 (diff) | |
| parent | 4811c14cc8ad57251e50e3aaa6d221f80603f577 (diff) | |
Merge pull request #3200 from Dygear/main
Documentation Link Fixes
Diffstat (limited to 'docs/pages')
| -rw-r--r-- | docs/pages/basic_application.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/new_project.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/nrf.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/overview.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/sharing_peripherals.adoc | 4 | ||||
| -rw-r--r-- | docs/pages/stm32.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/time_keeping.adoc | 4 |
7 files changed, 9 insertions, 9 deletions
diff --git a/docs/pages/basic_application.adoc b/docs/pages/basic_application.adoc index 7b4ebda4f..5c4e3e8b3 100644 --- a/docs/pages/basic_application.adoc +++ b/docs/pages/basic_application.adoc | |||
| @@ -4,7 +4,7 @@ So you've got one of the examples running, but what now? Let's go through a simp | |||
| 4 | 4 | ||
| 5 | == Main | 5 | == Main |
| 6 | 6 | ||
| 7 | The full example can be found link:https://github.com/embassy-rs/embassy/tree/master/docs/examples/basic[here]. | 7 | The full example can be found link:https://github.com/embassy-rs/embassy/tree/main/docs/examples/basic[here]. |
| 8 | 8 | ||
| 9 | NOTE: If you’re using VS Code and rust-analyzer to view and edit the examples, you may need to make some changes to `.vscode/settings.json` to tell it which project we’re working on. Follow the instructions commented in that file to get rust-analyzer working correctly. | 9 | NOTE: If you’re using VS Code and rust-analyzer to view and edit the examples, you may need to make some changes to `.vscode/settings.json` to tell it which project we’re working on. Follow the instructions commented in that file to get rust-analyzer working correctly. |
| 10 | 10 | ||
diff --git a/docs/pages/new_project.adoc b/docs/pages/new_project.adoc index 346d9f0f8..821bcbd27 100644 --- a/docs/pages/new_project.adoc +++ b/docs/pages/new_project.adoc | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | = Starting a new project | 1 | = Starting a new project |
| 2 | 2 | ||
| 3 | Once you’ve successfully xref:getting_started.adoc[run some example projects], the next step is to make a standalone Embassy project. | 3 | Once you’ve successfully xref:#_getting_started[run some example projects], the next step is to make a standalone Embassy project. |
| 4 | 4 | ||
| 5 | == Tools for generating Embassy projects | 5 | == Tools for generating Embassy projects |
| 6 | 6 | ||
diff --git a/docs/pages/nrf.adoc b/docs/pages/nrf.adoc index 1706087ae..de052b63f 100644 --- a/docs/pages/nrf.adoc +++ b/docs/pages/nrf.adoc | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | = Embassy nRF HAL | 1 | = Embassy nRF HAL |
| 2 | 2 | ||
| 3 | The link:https://github.com/embassy-rs/embassy/tree/master/embassy-nrf[Embassy nRF HAL] is based on the PACs (Peripheral Access Crate) from link:https://github.com/nrf-rs/[nrf-rs]. | 3 | The link:https://github.com/embassy-rs/embassy/tree/main/embassy-nrf[Embassy nRF HAL] is based on the PACs (Peripheral Access Crate) from link:https://github.com/nrf-rs/[nrf-rs]. |
| 4 | 4 | ||
| 5 | == Timer driver | 5 | == Timer driver |
| 6 | 6 | ||
diff --git a/docs/pages/overview.adoc b/docs/pages/overview.adoc index 1b9381bfe..7d59d5521 100644 --- a/docs/pages/overview.adoc +++ b/docs/pages/overview.adoc | |||
| @@ -48,7 +48,7 @@ link:https://github.com/lora-rs/lora-rs[lora-rs] supports LoRa networking on a w | |||
| 48 | link:https://docs.embassy.dev/embassy-usb/[embassy-usb] implements a device-side USB stack. Implementations for common classes such as USB serial (CDC ACM) and USB HID are available, and a rich builder API allows building your own. | 48 | link:https://docs.embassy.dev/embassy-usb/[embassy-usb] implements a device-side USB stack. Implementations for common classes such as USB serial (CDC ACM) and USB HID are available, and a rich builder API allows building your own. |
| 49 | 49 | ||
| 50 | === Bootloader and DFU | 50 | === Bootloader and DFU |
| 51 | link:https://github.com/embassy-rs/embassy/tree/master/embassy-boot[embassy-boot] is a lightweight bootloader supporting firmware application upgrades in a power-fail-safe way, with trial boots and rollbacks. | 51 | link:https://github.com/embassy-rs/embassy/tree/main/embassy-boot[embassy-boot] is a lightweight bootloader supporting firmware application upgrades in a power-fail-safe way, with trial boots and rollbacks. |
| 52 | 52 | ||
| 53 | == What is DMA? | 53 | == What is DMA? |
| 54 | 54 | ||
diff --git a/docs/pages/sharing_peripherals.adoc b/docs/pages/sharing_peripherals.adoc index 6ba13f93b..dfb8c1ffe 100644 --- a/docs/pages/sharing_peripherals.adoc +++ b/docs/pages/sharing_peripherals.adoc | |||
| @@ -8,7 +8,7 @@ The following examples shows different ways to use the on-board LED on a Raspber | |||
| 8 | 8 | ||
| 9 | Using mutual exclusion is the simplest way to share a peripheral. | 9 | Using mutual exclusion is the simplest way to share a peripheral. |
| 10 | 10 | ||
| 11 | TIP: Dependencies needed to run this example link:/book/dev/basic_application.html#_the_cargo_toml[can be found here]. | 11 | TIP: Dependencies needed to run this example link:#_the_cargo_toml[can be found here]. |
| 12 | [,rust] | 12 | [,rust] |
| 13 | ---- | 13 | ---- |
| 14 | use defmt::*; | 14 | use defmt::*; |
| @@ -78,7 +78,7 @@ To indicate that the pin will be set to an Output. The `AnyPin` could have been | |||
| 78 | 78 | ||
| 79 | A channel is another way to ensure exclusive access to a resource. Using a channel is great in the cases where the access can happen at a later point in time, allowing you to enqueue operations and do other things. | 79 | A channel is another way to ensure exclusive access to a resource. Using a channel is great in the cases where the access can happen at a later point in time, allowing you to enqueue operations and do other things. |
| 80 | 80 | ||
| 81 | TIP: Dependencies needed to run this example link:/book/dev/basic_application.html#_the_cargo_toml[can be found here]. | 81 | TIP: Dependencies needed to run this example link:#_the_cargo_toml[can be found here]. |
| 82 | [,rust] | 82 | [,rust] |
| 83 | ---- | 83 | ---- |
| 84 | use defmt::*; | 84 | use defmt::*; |
diff --git a/docs/pages/stm32.adoc b/docs/pages/stm32.adoc index 7bfc0592b..df139a420 100644 --- a/docs/pages/stm32.adoc +++ b/docs/pages/stm32.adoc | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | = Embassy STM32 HAL | 1 | = Embassy STM32 HAL |
| 2 | 2 | ||
| 3 | The link:https://github.com/embassy-rs/embassy/tree/master/embassy-stm32[Embassy STM32 HAL] is based on the `stm32-metapac` project. | 3 | The link:https://github.com/embassy-rs/embassy/tree/main/embassy-stm32[Embassy STM32 HAL] is based on the `stm32-metapac` project. |
| 4 | 4 | ||
| 5 | == The infinite variant problem | 5 | == The infinite variant problem |
| 6 | 6 | ||
diff --git a/docs/pages/time_keeping.adoc b/docs/pages/time_keeping.adoc index 17492a884..11ddb2b2b 100644 --- a/docs/pages/time_keeping.adoc +++ b/docs/pages/time_keeping.adoc | |||
| @@ -16,7 +16,7 @@ The `embassy::time::Timer` type provides two timing methods. | |||
| 16 | 16 | ||
| 17 | An example of a delay is provided as follows: | 17 | An example of a delay is provided as follows: |
| 18 | 18 | ||
| 19 | TIP: Dependencies needed to run this example link:/book/dev/basic_application.html#_the_cargo_toml[can be found here]. | 19 | TIP: Dependencies needed to run this example link:#_the_cargo_toml[can be found here]. |
| 20 | [,rust] | 20 | [,rust] |
| 21 | ---- | 21 | ---- |
| 22 | use embassy::executor::{task, Executor}; | 22 | use embassy::executor::{task, Executor}; |
| @@ -41,7 +41,7 @@ that expect a generic delay implementation to be provided. | |||
| 41 | 41 | ||
| 42 | An example of how this can be used: | 42 | An example of how this can be used: |
| 43 | 43 | ||
| 44 | TIP: Dependencies needed to run this example link:/book/dev/basic_application.html#_the_cargo_toml[can be found here]. | 44 | TIP: Dependencies needed to run this example link:#_the_cargo_toml[can be found here]. |
| 45 | [,rust] | 45 | [,rust] |
| 46 | ---- | 46 | ---- |
| 47 | use embassy::executor::{task, Executor}; | 47 | use embassy::executor::{task, Executor}; |
