docs: improve async guidance and examples

This commit is contained in:
2026-09-17 09:11:29 +10:00
parent 065aed893d
commit 42cb8f2324
9 changed files with 93 additions and 21 deletions
+3 -1
View File
@@ -5,9 +5,11 @@ The two PlatformIO Unity commands compile the complete DFTE test suites without
```bash
./scripts/test.sh compile --platform esp8266
./scripts/test.sh compile --platform esp32
./scripts/test.sh examples --platform esp8266
./scripts/test.sh examples --platform esp32
```
The test environments include the library sources with `test_build_src = yes`. CI runs both target checks on the maintained branch and pull requests.
The first two commands compile the library test suites with `test_build_src = yes`. The example commands compile every standalone project on each target, protecting the code that the documentation links users to. CI runs the library target checks on the maintained branch and pull requests.
The standalone examples are buildable PlatformIO projects; see [examples](../examples/README.md).