diff --git a/boards/README.md b/boards/README.md index 88dc1c0cf8..4e5ee73a02 100644 --- a/boards/README.md +++ b/boards/README.md @@ -19,9 +19,9 @@ but the approximate definitions: shape, but not heavily tested. Some Tier 2 boards may have known issues, which are documented in release notes during release testing. - - **Tier 3:** New or highly experimental. These should support the - minimum platform requirements laid out in - [the Porting documentation](../doc/Porting.md), but + - **Tier 3:** New or highly experimental. These should support the minimum + platform requirements laid out in [the Porting + documentation](https://book.tockos.org/development/porting), but make no promises beyond that. - **Other:** See each board for specific details. diff --git a/boards/nano33ble/README.md b/boards/nano33ble/README.md index 659f91a981..c240bd1ed5 100644 --- a/boards/nano33ble/README.md +++ b/boards/nano33ble/README.md @@ -1,7 +1,7 @@ Arduino Nano 33 BLE =================== - + The [Arduino Nano 33 BLE](https://store.arduino.cc/usa/nano-33-ble) and [Arduino Nano 33 BLE Sense](https://store.arduino.cc/usa/nano-33-ble-sense) are compact diff --git a/boards/nano33ble_rev2/README.md b/boards/nano33ble_rev2/README.md index 7f684043e6..f153b65358 100644 --- a/boards/nano33ble_rev2/README.md +++ b/boards/nano33ble_rev2/README.md @@ -1,7 +1,7 @@ Arduino Nano 33 BLE Sense Rev2 =================== - + The [Arduino Nano 33 BLE Sense Rev2](https://store.arduino.cc/products/nano-33-ble-sense-rev2) is a compact board based on the Nordic nRF52840 SoC. It includes the following sensors: diff --git a/boards/nano_rp2040_connect/README.md b/boards/nano_rp2040_connect/README.md index 7838ac5205..b8aee30332 100644 --- a/boards/nano_rp2040_connect/README.md +++ b/boards/nano_rp2040_connect/README.md @@ -1,7 +1,7 @@ Arduino Nano RP2040 Connect =========================== - + The [Arduino Nano RP2040 Connect](https://docs.arduino.cc/hardware/nano-rp2040-connect) is an Arduino Nano board built using the Raspberry Pi Foundation's RP2040 chip. diff --git a/boards/nordic/nrf52840dk/README.md b/boards/nordic/nrf52840dk/README.md index 608b577c05..21a0352ead 100644 --- a/boards/nordic/nrf52840dk/README.md +++ b/boards/nordic/nrf52840dk/README.md @@ -50,7 +50,7 @@ setting the `USB_DEBUGGING` constant to `true` in the [main.rs](src/main.rs) file. This disables the UART interface. For instructions about how to receive RTT messages on the host, see the -[corresponding capsule](../../../capsules/src/segger_rtt.rs). +[corresponding capsule](../../../capsules/extra/src/segger_rtt.rs). ## Debugging diff --git a/boards/sma_q3/README.md b/boards/sma_q3/README.md index d7d1162cb1..912ea66397 100644 --- a/boards/sma_q3/README.md +++ b/boards/sma_q3/README.md @@ -31,5 +31,5 @@ $ tockloader install --openocd --board sma_q3 ## Debugging -See the [nrf52dk README](../nrf52dk/README.md) for information about debugging +See the [nrf52dk README](../nordic/nrf52dk/README.md) for information about debugging the SMA Q3. Note: may need adjustment due to missing serial interface. diff --git a/boards/tutorials/nrf52840dk-thread-tutorial/README.md b/boards/tutorials/nrf52840dk-thread-tutorial/README.md index 7201115380..b556efe494 100644 --- a/boards/tutorials/nrf52840dk-thread-tutorial/README.md +++ b/boards/tutorials/nrf52840dk-thread-tutorial/README.md @@ -2,7 +2,7 @@ nRF52840DK Board Definition for the Tock Thread Tutorial ======================================================== This is the board definition for the nRF52840DK target used in the -[Thread Network tutorial](https://book.tockos.org/course/thread-network/overview). +[Thread Network tutorial](https://book.tockos.org/course/thread-net/overview). Please follow the instructions in that tutorial. You may also want to look at the documentation of the base nRF52840DK board definition diff --git a/capsules/core/src/low_level_debug/README.md b/capsules/core/src/low_level_debug/README.md index bb6a65d11d..e5550c1ca1 100644 --- a/capsules/core/src/low_level_debug/README.md +++ b/capsules/core/src/low_level_debug/README.md @@ -4,4 +4,4 @@ Low Level Debug The Low Level Debug capsule provides debugging facilities to userspace for debugging low-level issues such as miscompilation and incorrect relocation. It implements the system call API described -[here](../../../doc/syscalls/00008_low_level_debug.md). +[here](../../../../doc/syscalls/00008_low_level_debug.md). diff --git a/doc/ExternalDependencies.md b/doc/ExternalDependencies.md index 7be0d6c387..1424438d5c 100644 --- a/doc/ExternalDependencies.md +++ b/doc/ExternalDependencies.md @@ -146,10 +146,10 @@ be useful or desirable. ### Capsule Crate-Specific External Dependencies Capsules are a mechanism to provide semi-trusted infrastructure to a Tock board, -for instance non chip-specific peripheral drivers (see [Design](./Design.md)). -As such, external dependencies may be useful to implement complex subsystems. -Examples for this are wireless or networking protocols such as Bluetooth Low -Energy or TCP. +for instance non chip-specific peripheral drivers (see +[Design](https://book.tockos.org/doc/design)). As such, external dependencies +may be useful to implement complex subsystems. Examples for this are wireless or +networking protocols such as Bluetooth Low Energy or TCP. To support such use-cases without forcing all boards to include external dependencies, capsules are split into multiple crates: diff --git a/doc/syscalls/README.md b/doc/syscalls/README.md index 72cd43fe7a..964ee5fd8a 100644 --- a/doc/syscalls/README.md +++ b/doc/syscalls/README.md @@ -5,7 +5,7 @@ This folder contains the detailed documentation for the interfaces between userspace and the kernel. It includes details of the ABI interface, the kernel provided syscalls, and the driver specific interfaces (using `allow`, `schedule`, and `command`). For more information on the general syscalls, see -[here](../Syscalls.md). +[here](https://book.tockos.org/doc/syscalls). diff --git a/libraries/tickv/README.md b/libraries/tickv/README.md index 51a16055fc..2e0c2aeeae 100644 --- a/libraries/tickv/README.md +++ b/libraries/tickv/README.md @@ -8,7 +8,7 @@ on flash. It was written to be generic though, so other Rust applications can use it if they want. TicKV is based on similar concepts as -[Yaffs1](https://yaffs.net/documents/how-yaffs-works). +[Yaffs1](https://yaffs.net/sites/yaffs.net/files/HowYaffsWorks.pdf). ## Goals of TicKV diff --git a/libraries/tickv/SPEC.md b/libraries/tickv/SPEC.md index 3db743dfe7..d69c042510 100644 --- a/libraries/tickv/SPEC.md +++ b/libraries/tickv/SPEC.md @@ -10,9 +10,9 @@ to add such features. TicKV allows writing new key/value pairs (by appending them) and removing old key/value pairs. -Similar to (Yaffs1)[https://yaffs.net/documents/how-yaffs-works] TicKV uses a -log structure and circles over the flash data. This means that the file -system is inherently wear leveling as we don't regularly write to the same +Similar to [Yaffs1](https://yaffs.net/sites/yaffs.net/files/HowYaffsWorks.pdf) +TicKV uses a log structure and circles over the flash data. This means that the +file system is inherently wear leveling as we don't regularly write to the same flash region. ## Storage Format