<h1 align="center"> OmniAccelerANT Docs </h1>
<p align="center"> The guides for the Kataglyphis inference stack: Flutter, Rust/C++ and GStreamer. </p>
Documentation Map
| Topic | Description |
|---|---|
| Overview | ObservANT, targets, the repository's structure and design goals, feature status per platform, literature. |
| Getting Started | Prerequisites, clone, the lanes CI runs, run commands. |
| Platforms | Container, Windows, Raspberry Pi and Web builds. |
| Camera Streaming | The installable ObservANT (packages, endpoints, arrival picture and video, Home Assistant notifications and statistics, its tests), the Rust webcam inference, the GStreamer WebRTC pipelines. |
| ESP32-S3 Companion & Camera | The two firmware variants (Rust companion; ESP32-S3-EYE camera + ESP-DL), the shared USB-serial protocol (Detection and CameraDetection), the desktop-only Rust bridge, the Device page, the hardware probe, the on-device cat detection. |
| Testing | What each kind of test proves (unit, property, fuzz, integration, end-to-end, performance), what the app's Dart suite checks, the rules that keep a green run honest, how to run them, the known gaps. |
| Readmes | Links to the key README files in this repository. |
| Third-party Components | Every open-source component the packages ship, with its license and source; generated. |
| Project Operations | Tests, contribution process, repository hygiene, upgrade notes. |
| Upgrade Guide | Dependency and bridge updates. |
Update the docs in the same pull request as a change to behaviour or setup.