Merge #741

741: Docs 2 r=korken89 a=datdenkikniet

Working on the migration guide and other docs

TODO:
- [x] Migration guide
- [x] Hardcoded examples should link to example code that is tested (this was already done, AFAICT)
- [x] Address #699 
- [x] Discuss: should we remove references to non-v2, apart from the migration guide and link to the book for v1? (Off-github conclusion: yes)
- [x] RTIC {vs,and} Embassy (important: distinction between embassy runtime & HALs)
- [x] More descriptive docs on how to implement & PR implementations of `Monotonic` to `rtic-monotonics` 


Co-authored-by: datdenkikniet <jcdra1@gmail.com>

1 files changed, 24 insertions, 15 deletions

diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md
index 587117c..4083284 100644
--- a/book/en/src/SUMMARY.md
+++ b/book/en/src/SUMMARY.md
@@ -2,31 +2,40 @@
 
 [Preface](./preface.md)
 
+---
+
+- [Starting a new project](./starting_a_project.md)
 - [RTIC by example](./by-example.md)
   - [The `app`](./by-example/app.md)
-  - [Hardware tasks & `pend`](./by-example/hardware_tasks.md)
+  - [Hardware tasks](./by-example/hardware_tasks.md)
   - [Software tasks & `spawn`](./by-example/software_tasks.md)
   - [Resources](./by-example/resources.md)
   - [The init task](./by-example/app_init.md)
   - [The idle task](./by-example/app_idle.md)
   - [Channel based communication](./by-example/channel.md)
-  - [Delay and Timeout](./by-example/delay.md)
-  - [Starting a new project](./by-example/starting_a_project.md)
+  - [Delay and Timeout using Monotonics](./by-example/delay.md)
   - [The minimal app](./by-example/app_minimal.md)
-  - [Tips & Tricks](./by-example/tips.md)
-    - [Implementing Monotonic](./by-example/tips_monotonic_impl.md)
-    - [Resource de-structure-ing](./by-example/tips_destructureing.md)
-    - [Avoid copies when message passing](./by-example/tips_indirection.md)
-    - [`'static` super-powers](./by-example/tips_static_lifetimes.md)
-    - [Inspecting generated code](./by-example/tips_view_code.md)
-    <!-- - [Running tasks from RAM](./by-example/tips_from_ram.md) -->
-    <!-- - [`#[cfg(..)]` support](./by-example/tips.md) -->
+  - [Tips & Tricks](./by-example/tips/index.md)
+    - [Resource de-structure-ing](./by-example/tips/destructureing.md)
+    - [Avoid copies when message passing](./by-example/tips/indirection.md)
+    - [`'static` super-powers](./by-example/tips/static_lifetimes.md)
+    - [Inspecting generated code](./by-example/tips/view_code.md)
+- [Monotonics & the Timer Queue](./monotonic_impl.md)
 - [RTIC vs. the world](./rtic_vs.md)
+- [RTIC and Embassy](./rtic_and_embassy.md)
 - [Awesome RTIC examples](./awesome_rtic.md)
-<!-- - [Migration Guides](./migration.md)
-  - [v0.5.x to v1.0.x](./migration/migration_v5.md)
-  - [v0.4.x to v0.5.x](./migration/migration_v4.md)
-  - [RTFM to RTIC](./migration/migration_rtic.md) -->
+
+---
+
+- [Migrating from v1.0.x to v2.0.0](./migration_v1_v2.md)
+  - [Rust Nightly & features](./migration_v1_v2/nightly.md)
+  - [Migrating to `rtic-monotonics`](./migration_v1_v2/monotonics.md)
+  - [Software tasks must now be `async`](./migration_v1_v2/async_tasks.md)
+  - [Using and understanding `rtic-sync`](./migration_v1_v2/rtic-sync.md)
+  - [A code example on migration](./migration_v1_v2/complete_example.md)
+
+---
+
 - [Under the hood](./internals.md)
   - [Cortex-M architectures](./internals/targets.md)
   <!--- [Interrupt configuration](./internals/interrupt-configuration.md)-->