This directory holds repository-level documentation for the Styx workspace.
- development.md: repository layout, validation commands, and contribution expectations
- api-ergonomics.md: import surfaces, common task recipes, and typed API boundaries
- performance.md: benchmark surfaces and performance-validation notes
- runtime-debugging.md: runtime tracing, health, queue, and teardown diagnostics
- testing.md: default and example-oriented validation surfaces
- Using Styx: start with the root README.md and
crates/styx/README.md - Narrow facade imports: use the task modules documented in the root README.md
- Core media primitives: read
crates/core/README.md - Capture layers: read
crates/capture/README.md,crates/libcamera/README.md, andcrates/v4l2/README.md - Codec integrations: read
crates/codec/README.md - Running validation: read testing.md and
../testing/README.md