Commit Graph

15 Commits

Author SHA1 Message Date
JuliDi
c05149e5e4
add best practices first draft 2023-12-08 13:00:21 +01:00
Ulf Lilleengen
c94a9b8d75
Merge pull request #2260 from barnabywalters/main
Added Embassy in the wild docs page with links to some projects
2023-12-08 09:55:31 +00:00
Barnaby Walters
536e91d263 Added a step-by-step guide to starting a new embassy project
Based off an example, noting what to copy, what to change and why

Briefly summarizing how to require embassy crates via github

All steps tested and proven working at the time of writing
2023-12-06 23:51:13 +01:00
Barnaby Walters
cd62d2cd84 Added embassy in the wild docs page with two projects 2023-12-06 21:10:16 +01:00
Barnaby Walters
a76dd2d70f Moved content from the wiki to the docs
New: delaying_a_task.adoc, copied as-is from the wiki and placed in the
navigation until we have a better place for it (or remove/replace it)

index: Tweaked the structure, added some content from the wiki, and made
some general copy edits to improve clarity.

getting_started.adoc: Corrected various out-of-date information, added
troubleshooting tips from the wiki, added some new information, various
other small edits.

basic_application.adoc: Corrected out-of-date information, various clarifications
and edits.

After these changes, IMO most of the content on the github wiki is no longer
necessary and can be removed for clarity. The few sections I didn‘t integrate
or copy over were either out of date or unfinished.
2023-12-05 01:01:50 +01:00
Adin Ackerman
142f42fe90 ... 2023-11-27 10:44:47 -08:00
James Munns
aedd41eac4 Add FAQ with one question from chat 2023-11-21 15:38:33 +01:00
Ulf Lilleengen
80a740bc72 docs: minor doc improvements and cleanup 2023-10-03 21:35:31 +02:00
xoviat
537e2f3b44 update docs 2023-09-16 08:19:49 -05:00
Ulf Lilleengen
d769e562c0 Rewrite documentation using correct module names
* Remove traits section now that we have embedded-hal-async and refer to
  it.
* Explanation that embassy is multiple things.
* Bootloader description image
2022-08-16 11:27:57 +02:00
Ulf Lilleengen
484e0acc63 Add stm32 flash + bootloader support
* Add flash drivers for L0, L1, L4, WB and WL. Not tested for WB, but
should be similar to WL.
* Add embassy-boot-stm32 for bootloading on STM32.
* Add flash examples and bootloader examples
* Update stm32-data
2022-04-27 15:17:18 +02:00
Ulf Lilleengen
092eef3ae7 Add documentation about the different embassy abstraction layers
The guide demonstrates the functionality offered by each
layer in Embassy, using code examples.
2022-02-23 09:48:32 +01:00
Ulf Lilleengen
b48fcd9229 Add more content 2021-12-10 12:04:12 +01:00
Ulf Lilleengen
5c4a9043d1 Update docs 2021-12-09 10:40:26 +01:00
Ulf Lilleengen
c12337920f Initial PoC of embassy book 2021-12-09 10:06:17 +01:00