Commit graph

167 commits

Author SHA1 Message Date
kalkyl
af9c7379f9 Add link to example in book 2024-07-08 22:53:50 +02:00
kalkyl
028ca55f9c Add more docs and cross-links 2024-07-08 17:16:35 +02:00
J. Neuschäfer
e3b495908c docs: Fix mention of ExtiInput
The struct is called ExtiInput, not ExtiButton.
2024-06-27 16:48:48 +02:00
Dario Nieuwenhuis
ad7d739ddc
Merge pull request #3062 from kkrolczyk/kk/bootloader-typos
fix docu typos, linker addr example
2024-06-10 20:48:41 +00:00
Krzysztof Królczyk
268430bd9f
stm32/docs: correct typos, links
Signed-off-by: Krzysztof Królczyk <Krzysztof.Krolczyk@o2.pl>
2024-06-10 11:25:43 +02:00
Ulf Lilleengen
30918c355b prepare for embassy-time 0.3.1 release 2024-06-04 09:02:41 +02:00
Ulf Lilleengen
d2045be9f3 fix broken links to embassy book 2024-06-03 08:45:05 +02:00
Priit Laes
4d431b3080 docs: faq: Fix link to bdma example and improve wording. 2024-05-28 11:27:21 +03:00
James Munns
ad45725a24
Update docs/pages/faq.adoc 2024-05-25 19:33:13 +02:00
James Munns
9c32c43cf8
FAQ: One vs Many tasks
Copy and paste from chat
2024-05-25 19:32:02 +02:00
James Munns
495a29ad6e Explicitly license the book prose CC-BY-SA
This matches the Rust Embedded books
2024-05-23 09:57:10 +02:00
Ulf Lilleengen
bb9c687a39 update crate paths 2024-05-21 10:05:21 +02:00
Ulf Lilleengen
06218f9536 fix internal refs 2024-05-21 10:05:21 +02:00
Ulf Lilleengen
38946114d8 update links 2024-05-21 10:05:21 +02:00
Ulf Lilleengen
797f5c1e5e add book ci script 2024-05-21 10:05:21 +02:00
Ulf Lilleengen
2991099daa move images and add makefile 2024-05-21 10:05:21 +02:00
Ulf Lilleengen
739e5861c2 convert from antora to asciidoctor 2024-05-21 10:05:21 +02:00
Charles Cabergs
98b06d7646
Fix typo in sharing_peripherals.adoc 2024-05-20 20:28:13 +02:00
Dario Nieuwenhuis
3a24e6b465
Merge pull request #2897 from andelf/add-ch32-hal-to-list
Add ch32-hal to HAL list, support WCH's CH32V family
2024-05-20 13:23:42 +02:00
James Munns
c590e91c0b
FAQ: Fix section nesting 2024-05-17 14:11:42 +02:00
James Munns
4722bac07c
FAQ: "How to add support for a new chip"
This adds an opinionated process for supporting a brand new (family of) chip(s) in Embassy.
2024-05-17 11:07:47 +02:00
James Munns
61fa95f353
Update docs/modules/ROOT/pages/faq.adoc 2024-05-12 21:09:51 +02:00
James Munns
3294ca36ce
FAQ: add patch.crates-io example 2024-05-12 21:07:37 +02:00
Pegasis
3e87dae578 add example for bdma 2024-05-03 08:14:32 -04:00
Andelf
5568cb89c3 Add ch32-hal to HAL list 2024-05-01 08:15:22 +08:00
Dario Nieuwenhuis
f2c95b86e7
Merge pull request #2844 from Dygear/doc-updates
Link back to Cargo.toml section.
2024-04-26 20:28:34 +00:00
Haobo Gu
5002ff00de doc: add RMK to embassy in the wild
Signed-off-by: Haobo Gu <haobogu@outlook.com>
2024-04-25 23:50:51 +08:00
Mark Tomlin
7b47d53de2
Update sharing_peripherals.adoc
Fixed Typo.
2024-04-22 17:01:22 -04:00
Mark Tomlin
ebb3148124
Update time_keeping.adoc
Fixed Typo.
2024-04-22 17:00:44 -04:00
Joël Schulz-Ansres
79fbdb1fe0 Add USB debugging section to FAQ 2024-04-22 00:38:09 +02:00
Mark Tomlin
b03f23ab64
Update sharing_peripherals.adoc 2024-04-19 21:36:03 -04:00
Mark Tomlin
b2f7ce99d6
Update time_keeping.adoc 2024-04-19 21:35:25 -04:00
Oleksandr Kuksenko
0dcf034857
Update layer_by_layer.adoc
Fixed typo
2024-04-19 13:37:58 +03:00
James Munns
8988df9ac1
FAQ: Common STM32 stumbling blocks
Adds some commonly encountered issues.

Help wanted: if anyone has a working BDMA linker script setup, it would be good to add here.
2024-04-16 11:07:42 +02:00
Dario Nieuwenhuis
0e1208947e
Merge pull request #2741 from schmettow/patch-1
Added YLab project to "in the wild"
2024-04-04 21:44:40 +00:00
David Zwart
446965a903
Update faq.adoc 2024-04-03 22:33:21 +02:00
David Zwart
7aef047def
Update faq.adoc
github link
2024-04-03 22:32:28 +02:00
David Zwart
54be08afe4
Update faq.adoc with memory.x definition helping hand 2024-04-03 22:24:09 +02:00
schmettow
f10ee07a90
Update embassy_in_the_wild.adoc
corrected link to Ystudio project
2024-03-28 14:35:24 +01:00
schmettow
82046c4691
Added YLab project to "in the wild"
YLab uses Embassy
2024-03-26 22:26:44 +01:00
Andreas Schmidt
4c0d63ce61
docs: update broken reference in basic_application.adoc 2024-03-01 10:13:59 +01:00
Andreas Schmidt
e954d1716a
docs: update basic example references in basic_application.adoc 2024-02-29 20:27:35 +01:00
Barnaby Walters
d07a0148d7 Documented rp2040 probe-rs info bug, linked to new_project page 2024-02-28 15:48:37 +01:00
Barnaby Walters
2787164ea9 grammar fix 2024-02-28 15:15:43 +01:00
Barnaby Walters
990b44566c [docs] Added some failure modes to watch out for
* Linked to probe.rs website rather than the crates.io page
* Fixed some formatting errors (>:( grrr asciidoc)
* Added cargo add probe-rs failure mode
* Added pico-w vs pico blinky failure mode
2024-02-28 15:11:30 +01:00
James Munns
4a0b1cbadb
Update docs/modules/ROOT/pages/faq.adoc 2024-02-13 15:23:50 +01:00
Ralf
f9af0096bd FAQ add hint to embassy-time linker error to include HAL in linking 2024-02-13 15:04:47 +01:00
Ulf Lilleengen
fd9318f205
Merge pull request #2354 from AdinAck/docs-generation-1
Add Generation Repos to Docs
2024-02-09 19:33:16 +00:00
Priit Laes
cbdc49ef8d faq: embassy-time was split into three packages, update faq accordingly
I ran into this issue when I had to pull in embassy-nrf from git,
though cargo didn't complain about conflicting embassy-time links.
2024-02-09 10:15:53 +02:00
Priit Laes
6e2d54c40b faq: Nightly is not required anymore 2024-02-09 10:14:55 +02:00