Skip to content

Phase A1: make README honest (implemented vs planned) - #5

Closed
mandarwagh9 wants to merge 1 commit into
feat/phaseA-0-tooling-cifrom
feat/phaseA-1-honest-docs
Closed

mandarwagh9 wants to merge 1 commit into
feat/phaseA-0-tooling-cifrom
feat/phaseA-1-honest-docs

Conversation

@mandarwagh9

Copy link
Copy Markdown
Owner

What & why

Phase A1 of the OVERWATCH 10× roadmap. The README sold several headline features as shipped that aren't actually wired into the pipeline. This makes the docs truthful and fixes concrete drift — docs-only, no behaviour change.

⚠️ Stacked on #4 (base = feat/phaseA-0-tooling-ci). GitHub will auto-retarget this to main once #4 merges. Review #4 first.

Changes

  • New "Implementation status" table at the top — the single source of truth (✅ implemented vs 🔭 planned).
  • Marked 🔭 planned (designed but not in the pipeline): cross-camera homography (H-PROJ), pixel extrapolation (EXTRAP), appearance re-ID, sensor-trust scoring, adaptive-Kalman-by-bbox-area, GPS/IMU fusion, DeepSORT/centroid fallback, compass ribbon, threat ring.
  • Reframed the homography section as forward-looking design; noted only the orange WORLD ghost path is emitted today.
  • Fixed the mobile handshake doc (target_fps is not sent; sensor_data is received but not fused).
  • Updated the Testing section for the new frontend tests + the comprehensive CI gate.
  • pyproject: requires-python<3.14 (3.13 verified working locally).
  • .env.example: removed the duplicated JWT/AUTH block.

Verification

  • ruff clean · mypy clean (16 files) · pytest 57 passed (no Python source changed).
  • Diff is 3 files: README.md, backend/.env.example, pyproject.toml.

🤖 Generated with Claude Code

Phase A1 of the 10x roadmap. The README advertised several capabilities as
shipped that aren't wired into the live pipeline; this marks them as planned and
fixes concrete drift.

- Add an "Implementation status" table up front (source of truth: ✅ vs 🔭)
- Mark 🔭 planned: cross-camera homography (H-PROJ), pixel extrapolation (EXTRAP),
  appearance re-ID, sensor-trust scoring, adaptive-Kalman-by-area, GPS/IMU fusion,
  DeepSORT/centroid fallback chain, compass ribbon, threat ring
- Reframe the homography section as forward-looking design
- Note only the orange WORLD ghost path is emitted today
- Fix mobile handshake (no target_fps is sent; sensor_data is received, not fused)
- Update Testing section for the new frontend tests + comprehensive CI gate
- pyproject: allow Python 3.13 (requires-python <3.14; verified locally)
- .env.example: remove the duplicated JWT/AUTH block

No code behaviour change; backend gate green (ruff/mypy/57 tests).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant