No description
- Rust 100%
Add a validated getting-started guide and complete public API documentation so applications and agents can use the runtime from an explicit, consistent contract. Clarify cancellation timing, detached task retention, output ownership, and observation scheduling to prevent assumptions that leave work running or miss state changes. Preserve runtime behavior. |
||
|---|---|---|
| docs | ||
| examples | ||
| src | ||
| tests | ||
| .gitignore | ||
| AGENTS.md | ||
| Cargo.toml | ||
Documentation
This directory is the canonical entry point for repository documentation.
getting-started.md: setup, a runnable first task, and the execution boundary; also published as the crate-level rustdoc.development.md: development, testing, documentation, and commit requirements.runtime-model.md: runtime ownership, wait protocol, lifecycle, and extension boundaries.primitives.md: supported await primitives and their behavioral contracts.observation.md: signal and watch semantics, lifecycle, scheduling, and costs.watch-adapters.md: bridge Bevy resource and component changes into watches.conditions.md: application condition lifecycle, completion, and cost contracts.task-handles.md: task creation, output ownership, composition, and cancellation.
All new repository documents MUST be added under docs/ and linked from this index.
Examples
Run each example with cargo run --example <name>.
| Example | Focus |
|---|---|
orchestration |
Frame and virtual-time waits, domain conditions, and ECS task inspection. |
condition_wait |
Unit and typed-value completion from ordinary systems. |
task_spawn |
Task-side spawning, joining, and cancellation. |
composition |
Tuple/vector join and select, frame timeout, and frame polling. |
observation |
Resource/component watch adapters and transient signals. |
real_time |
Unscaled sleep and timeout while virtual time is paused. |