Skip to content

docs: tighten README + drop superpowers plans - #2

Merged
mandarwagh9 merged 1 commit into
mainfrom
docs/readme-and-cleanup
Apr 30, 2026
Merged

mandarwagh9 merged 1 commit into
mainfrom
docs/readme-and-cleanup

Conversation

@mandarwagh9

Copy link
Copy Markdown
Owner

Summary

  • README rewrite — fix duplicates, update stale references, document Phase-0..6 changes
  • Remove docs/superpowers/plans/ — internal planning doc no longer needed in tree

README changes

Deduplication

  • Removed the duplicated Quick Start sub-section (steps 2–4 appeared twice from a previous merge)
  • Removed the standalone Deployment section that just repeated the Quick Start deploy block

Stale references fixed

  • force_restart.py / fix_jetson.py (archived in Phase 6) → check_logs.py, restart_jetson.py
  • world_model.pyworld_model_adapter.py
  • _simple_world_to_pixel() (deleted) → references the actual CoordinateTransformer.world_to_pixel()
  • Hardcoded 192.168.1.12 examples now use <jetson-host> placeholders

New content

  • CI badge wired to the GitHub Actions workflow
  • Testing section pointing at the 57-test pytest suite
  • New env vars documented: AUTH_ENABLED, JWT_SECRET, CORS_ORIGINS, MAX_WS_CLIENTS
  • Deploy env vars documented: JETSON_HOST, JETSON_USER, JETSON_PASS, JETSON_KEY
  • --rollback flag and atomic SFTP staging called out
  • dt clamp + 2s per-client broadcast timeout mentioned in the relevant sections

Preserved as-is

  • Hero badges, demo video, architecture diagram
  • Homography deep-dive (the most valuable technical content)
  • Edge cases & limitations tables
  • References & sources, Tech stack, License

Test plan

  • Render the README on GitHub and confirm CI badge resolves and all internal anchor links work
  • Confirm docs/superpowers/plans/2026-04-30-overwatch-hardening.md is gone (ls docs should fail or return nothing)
  • Spot-check that none of the new env-var names contradict the actual Settings class in backend/app/infrastructure/config_adapter.py

…changes

- Remove duplicated Quick Start and Deployment sections (merge cruft)
- Update Project Structure to include backend/tests/, scripts/archive/, infrastructure/auth.py
- Add CI badge linking to GitHub Actions workflow
- Add Testing section pointing at the 57-test pytest suite
- Document new env vars: AUTH_ENABLED, JWT_SECRET, CORS_ORIGINS, MAX_WS_CLIENTS
- Document deploy env vars: JETSON_HOST, JETSON_USER, JETSON_PASS, JETSON_KEY
- Document --rollback flag and atomic SFTP staging
- Replace stale references to force_restart.py / fix_jetson.py with check_logs.py / restart_jetson.py
- Replace dead 'world_model.py' / '_simple_world_to_pixel()' references with current names
- Mention 2s per-client broadcast timeout and dt clamp in fusion notes
Copilot AI review requested due to automatic review settings April 30, 2026 18:33
@mandarwagh9
mandarwagh9 merged commit 4df6570 into main Apr 30, 2026
3 checks passed
@mandarwagh9
mandarwagh9 deleted the docs/readme-and-cleanup branch April 30, 2026 18:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates repository documentation to reflect the current Phase-0..6 state and removes an internal planning artifact that’s no longer needed in-tree.

Changes:

  • Rewrites/tightens README.md (dedupes sections, updates stale references, adds CI/testing/env-var/deploy details).
  • Removes the internal plan doc under docs/superpowers/plans/.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/superpowers/plans/2026-04-30-overwatch-hardening.md Deletes an outdated internal implementation plan document.
README.md Refreshes project overview, quick start/deploy/testing docs, env vars, and links to match the current codebase.
Comments suppressed due to low confidence (1)

README.md:212

  • Local dev instructions run python main.py, but Settings.ssl_enabled defaults to true and certs/ is gitignored (not present on a fresh clone). With DEBUG=false (default), the backend will SystemExit if cert/key files aren’t available. Document the required setup (generate certs, or set SSL_ENABLED=false, or set DEBUG=true) so the Quick start works for a new contributor.
# Backend
cd backend
pip install -r requirements.txt
python main.py


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +552 to +553
# Or manually over SSH:
JETSON_HOST=192.168.1.10 JETSON_PASS=... ssh "$JETSON_USER@$JETSON_HOST" \

Copilot AI Apr 30, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The manual SSH one-liner sets JETSON_PASS=... but ssh doesn’t use that env var (it will still prompt or require keys), and it references $JETSON_USER without setting it. Consider removing JETSON_PASS from this example and either hardcode the placeholder user/host (ssh <user>@<host> ...) or show JETSON_USER=... JETSON_HOST=... ssh "$JETSON_USER@$JETSON_HOST" ... with a note that password entry is interactive (or requires keys/ssh-agent).

Suggested change
# Or manually over SSH:
JETSON_HOST=192.168.1.10 JETSON_PASS=... ssh "$JETSON_USER@$JETSON_HOST" \
# Or manually over SSH (password entry is interactive unless you use SSH keys/ssh-agent):
JETSON_USER=<jetson-user> JETSON_HOST=192.168.1.10 ssh "$JETSON_USER@$JETSON_HOST" \

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +19 to 23
<a href="#demo-video">Demo</a> ·
<a href="#-features">Features</a> ·
<a href="#-architecture">Architecture</a> ·
<a href="#-quick-start">Quick Start</a> ·
<a href="#-deployment">Deployment</a> ·

Copilot AI Apr 30, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The top navigation uses anchors like #-features / #-architecture / #-quick-start / #-deployment, but the corresponding headings render GitHub IDs without the leading hyphen (e.g. #features, #architecture, #quick-start, #deployment). As written, these links will be broken on GitHub; update the href targets to the actual generated heading IDs.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +24 to 26
<a href="#-testing">Testing</a> ·
<a href="#-api-reference">API</a> ·
<a href="#-troubleshooting">Troubleshooting</a>

Copilot AI Apr 30, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue as above for the remaining top-nav links (#-testing, #-api-reference, #-troubleshooting): GitHub heading IDs won’t include the leading -, so these anchors won’t resolve. Update the href values to match the rendered section IDs (e.g. #testing, #api-reference, #troubleshooting).

Suggested change
<a href="#-testing">Testing</a> ·
<a href="#-api-reference">API</a> ·
<a href="#-troubleshooting">Troubleshooting</a>
<a href="#testing">Testing</a> ·
<a href="#api-reference">API</a> ·
<a href="#troubleshooting">Troubleshooting</a>

Copilot uses AI. Check for mistakes.
Comment thread README.md
@@ -242,158 +218,111 @@ npm start

Open **https://localhost:3000** — accept the self-signed certificate warning.

Copilot AI Apr 30, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

npm start (CRA) serves HTTP by default and this repo doesn’t include an HTTPS=true frontend env configuration, so https://localhost:3000 / “self-signed certificate warning” is misleading. Either change this to http://localhost:3000 or document how to run the dev server with HTTPS (including cert generation/trust steps) if that’s required for getUserMedia.

Suggested change
Open **https://localhost:3000** — accept the self-signed certificate warning.
Open **http://localhost:3000**.

Copilot uses AI. Check for mistakes.
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.

2 participants