Commit graph

98 commits

Author SHA1 Message Date
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
Priit Laes
bb743420be faq: Fix typo 2024-02-09 10:14:34 +02:00
Ulf Lilleengen
7817c8b17c docs: fix bullet point indentation 2024-02-05 09:10:53 +01:00
Matous Hybl
4650a35661 docs: Embassy in the wild - add air quality monitoring system 2024-02-03 09:41:14 +01:00
James Munns
5e7876c800
Update docs/modules/ROOT/pages/faq.adoc 2024-01-30 12:41:46 +01:00
James Munns
f388074338 Add some comments from chat 2024-01-30 10:34:09 +01:00
Shane Snover
3c159205a7 Fix the backticks on the getting started page 2024-01-25 22:30:42 -07:00
James Munns
40e9fc36dc
Update faq.adoc
Don't suggest people disable debuginfo, and explain why
2024-01-23 12:06:28 +01:00
Adin Ackerman
b825f76c28 add extra info to stable arena usage 2024-01-16 20:00:39 -08:00
Barnaby Walters
d2d9175a1d Added manual ISR FAQ 2024-01-13 02:14:56 +01:00
Ulf Lilleengen
ff5f5021fb cleanup docs and add channel synchronization example 2024-01-10 09:52:46 +01:00
Vasil Nikolov
781e33023e add draft doc page for peripheral sharing 2024-01-10 00:49:54 +02:00
James Munns
7dec3ccca4
[FAQ]: Link to Arena configuration docs 2024-01-02 18:44:41 +01:00
Benjamin Ward
79cb62c9b4
Expand LoRa crate notes per PR review 2024-01-01 10:23:57 -05:00
Benjamin Ward
fa9cb99cb6 Update docs to reflect current LoRa crate name/location 2023-12-30 21:30:27 -05:00
Adin Ackerman
9ea7a245e9 add some generation resources, add some feature descriptions 2023-12-24 11:51:16 -08:00
Dániel Buga
cf0e5e32ad Remove Xtensa specifier 2023-12-21 14:27:58 +01:00
Ulf Lilleengen
876faa5685 docs: more docs in embassy-boot crate documentation 2023-12-13 19:00:26 +01:00
Dario Nieuwenhuis
3ef18ec133
Merge pull request #2263 from embassy-rs/jamesmunns-patch-2
Tweak FAQ size profile suggestions
2023-12-08 20:50:00 +01:00
Dario Nieuwenhuis
4e7b855b2d
Merge pull request #2265 from JuliDi/docs-best-practices
[Docs] Add best practices page
2023-12-08 20:49:45 +01:00
Dario Nieuwenhuis
3f30e87cb5
Merge pull request #2251 from JuliDi/faq-performance-tweaks
[FAQ] Add section about speed optimization
2023-12-08 19:35:32 +00:00
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
James Munns
8fa5a6b282
Tweak FAQ size profile suggestions
If we want the smallest binary, we probably want codegen-units = 1, and disable incremental builds.
2023-12-07 14:27:09 +01:00
Barnaby Walters
16e31747cc Changed example project name 2023-12-07 00:54:39 +01: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
ecaa62aa42 Fixed merge conflict 2023-12-06 21:55:07 +01:00
Barnaby Walters
7561696a57 Added lora-rs links 2023-12-06 21:47:52 +01:00
Barnaby Walters
195b492158
Update docs/modules/ROOT/pages/embassy_in_the_wild.adoc
Co-authored-by: Dániel Buga <bugadani@gmail.com>
2023-12-06 21:13:56 +01:00
Barnaby Walters
10c9e2e723 Added description for Card/IO 2023-12-06 21:11:34 +01:00
Barnaby Walters
cd62d2cd84 Added embassy in the wild docs page with two projects 2023-12-06 21:10:16 +01:00
JuliDi
1f6ffdcdd2
fix Cargo.toml and config.toml keys 2023-12-05 10:10:47 +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
JuliDi
bf7115cb44
remove unnecessary backtick 2023-12-04 21:20:18 +01:00
JuliDi
0b0ca62a95
add speed optimization 2023-12-04 20:59:08 +01:00
Dario Nieuwenhuis
ce4dd67f3b
Merge pull request #2236 from tshepang/patch-2
no_std and no_main can be used on stable
2023-12-01 18:10:27 +01:00
Tshepang Mbambo
33cfef871d
no_std and no_main can be used on stable 2023-12-01 11:56:35 +02:00
Tshepang Mbambo
270504d87d
runtime.adoc: typo 2023-12-01 08:45:20 +02:00
Dániel Buga
a3c99f0324 Add multiple dependency error faq 2023-11-28 08:12:23 +01:00
James Munns
74a6855f01
Update docs/modules/ROOT/pages/faq.adoc 2023-11-27 21:43:05 +01:00
James Munns
f88aa9ce48
(FAQ): Add time driver note 2023-11-27 21:42:10 +01:00