Commit 5b6d3e0
authored
docs: improve Getting Started — fix root README example, expand python-async README, document dora run vs dora start (#1576)
## What this fixes
### Root `README.md`
- The "Run" section described a YOLO/webcam example but pointed to
`examples/python-dataflow/dataflow.yml`, which is actually the `sender →
transformer → receiver` pipeline — not a YOLO pipeline and no webcam
required.
- Corrected the shown YAML to match the actual file.
- Removed the misleading `> Make sure to have a webcam` note.
- Added a `dora run` vs `dora start` comparison table (sourced from code
comments in `binaries/cli/src/command/run.rs` and `start/mod.rs`).
### `examples/python-async/README.md`
- Was 4 lines with no explanation of what the example demonstrates or
what "async" means in this context.
- Rewrote to include: node descriptions, ASCII dataflow diagram, sync vs
async API comparison table, and expected output.
## Why
Both files were entry points for new users. The root README mismatch
(YOLO description + non-YOLO URL) would cause confusion on first run.
The `python-async` README gave no signal to readers about when or why to
use the async API.
## Testing
- Verified YAML structure against
`examples/python-dataflow/dataflow.yml` directly.
- Verified `dora run` vs `dora start` distinction against source in
`binaries/cli/src/command/run.rs` (lines 1–6) and `start/mod.rs` (lines
1–3).
- Verified `python-async` node behaviour by reading `send_data.py` and
`receive_data.py`.1 file changed
+49
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
4 | 35 | | |
5 | 36 | | |
| 37 | + | |
6 | 38 | | |
7 | 39 | | |
8 | 40 | | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
9 | 46 | | |
10 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
0 commit comments