mirror of
https://github.com/azaion/gps-denied-onboard.git
synced 2026-06-22 19:11:14 +00:00
Update autodev state, architecture documentation, and glossary terms
Transitioned the autodev state to phase 21, reflecting the completion of Step 5 and the drafting of Step 6 epics. Revised the architecture documentation to clarify the roles of the Tile Manager and its components, ensuring accurate representation of the system's operational flow. Updated glossary entries for Flight State and Operator to incorporate recent changes and enhance clarity on component interactions and responsibilities.
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
# System Flow Diagrams — Index
|
||||
|
||||
The canonical Mermaid sequence diagrams + flowcharts for every system flow live in the single source of truth `_docs/02_document/system-flows.md`. This index file exists so the `diagrams/` directory has a discoverable per-flow entry point matching the artifact-management convention; **do not duplicate Mermaid bodies here** — keep them in `system-flows.md` so they cannot drift.
|
||||
|
||||
## Per-flow links
|
||||
|
||||
| Flow | Description | Section in `system-flows.md` |
|
||||
|------|-------------|------------------------------|
|
||||
| F1 | Pre-flight cache provisioning | `## Flow F1: Pre-flight cache provisioning` |
|
||||
| F2 | Takeoff load (cold-start TTFF, AC-NEW-1) | `## Flow F2: Takeoff load` |
|
||||
| F3 | Steady-state per-frame estimation (the F3 hot path) | `## Flow F3: Steady-state per-frame estimation` |
|
||||
| F4 | Mid-flight tile generation + local cache write | `## Flow F4: Mid-flight tile generation + local cache write` |
|
||||
| F5 | Visual blackout + spoofed-GPS failsafe (AC-NEW-8) | `## Flow F5: Visual blackout + spoofed-GPS failsafe` |
|
||||
| F6 | Sharp-turn / disconnected-segment re-localization | `## Flow F6: Sharp-turn / disconnected-segment re-localization` |
|
||||
| F7 | Spoofing-promotion via EKF source-set switch (AC-NEW-2) | `## Flow F7: Spoofing-promotion via EKF source-set switch` |
|
||||
| F8 | Companion reboot recovery | `## Flow F8: Companion reboot recovery` |
|
||||
| F9 | GCS telemetry stream (AC-6.1) | `## Flow F9: GCS telemetry stream` |
|
||||
| F10 | Post-landing tile upload (D-PROJ-2 contract) | `## Flow F10: Post-landing tile upload` |
|
||||
|
||||
Each section in `system-flows.md` contains: description, preconditions, Mermaid sequence diagram, Mermaid flowchart, data-flow table, error scenarios, and performance expectations.
|
||||
|
||||
## Component-level diagram
|
||||
|
||||
The component-level diagram (showing component boundaries and inter-component edges) is `_docs/02_document/diagrams/components.drawio`. It is the visual companion to the per-component specs under `_docs/02_document/components/`.
|
||||
|
||||
## Conventions reminder
|
||||
|
||||
Per `.cursor/skills/plan/templates/system-flows.md` § Mermaid Diagram Conventions:
|
||||
- Component-named participants (e.g. `participant C5 as C5 StateEstimator`).
|
||||
- camelCase node IDs.
|
||||
- `{Question?}` decisions, `([label])` start/end, `[[label]]` for external systems.
|
||||
- No inline styling.
|
||||
|
||||
If a new flow Fn is added, insert it in `system-flows.md` AND add a row above. Do NOT create separate flow files unless the project later decides to split `system-flows.md` per flow (in which case this index becomes the table of contents and the Mermaid bodies move).
|
||||
Reference in New Issue
Block a user