chore: polish FSOC repository for SIH presentation - #2
Merged
Merged
Conversation
Non-functional, judge-facing repository polish only -- no algorithm, model, controller, or measured behavior changed. Rewrites README.md from a chronological "Step 1 already implemented -> Step 2 ..." development log into a judge-facing landing page: problem statement, what FSOC does (SEE -> ESTIMATE -> PREDICT -> CORRECT), a Mermaid architecture diagram that explicitly separates the simulation environment from a labeled "not built, not claimed" future hardware interface, a measured-results table (with deliberate wording: "~99.5% reduction in severe outliers," never "99.5% accuracy"), a real (not fabricated) demo image plus a documented manual- capture TODO for a Mission Control screen recording, verified quick-start commands, and Known Limitations / Hardware Boundary sections carried forward verbatim from docs/SIH_MVP_FREEZE.md's safe-claims list. Moves the detailed Step 1-11 chronological build log (exact numbers, test counts, implementation notes) out of README.md into a new docs/DEVELOPMENT_HISTORY.md, preserved verbatim -- no engineering fact lost, just relocated so a judge doesn't have to scroll past 11 build-step headers to reach architecture/results. Archives four stale root-level starter-kit artifacts (KIT_MANIFEST.md, MIGRATION_FROM_PYTHON.md, FILES.txt, VALIDATION.txt -- all from the original Python-to-C++20 conversion, fully superseded by current docs) into docs/archive/ via `git mv`, each with a one-line "archived, here's why, see X for the current version" header. Retitles CHECKLIST.md from "48-Hour MVP Checklist" to reflect that it now covers Stage 2-4 AI perception and P0-v2 state estimation too. Verified before committing: golden-demo commands (normal/clutter/static --mode hybrid --tracker) re-run and match documented output exactly; no prohibited claim (real hardware, embedded performance, "clutter solved," "44.9% eliminated," "99.5% accuracy") appears anywhere in the new text. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014h1TXJD8THZH4NbMqzrx97
Adds .github/workflows/ci.yml -- previously only a .github/workflows_placeholder.md existed, no automated build/test signal on this public repository at all. Two jobs, both on ubuntu-latest, on every pull_request and push to main: - cpp: installs CMake/Ninja via pip (avoids relying on the runner's preinstalled cmake version, which can lag the project's cmake_minimum_required 3.24) and libopencv-dev via apt (verified against actual usage in the codebase -- no OpenCV-5-specific API is used, only stable 4.x-compatible calls), then runs the exact local pipeline: cmake --preset debug, cmake --build --preset debug, ctest --preset debug. - frontend: npm ci, typecheck, lint, production build, then Playwright E2E against the REPLAY fixtures. playwright.config.ts uses channel:"chrome" (the system browser, not a Playwright-managed download), so Chrome is installed explicitly via browser-actions/setup-chrome rather than assumed present on the runner image. Validated locally: `ruby -ryaml` confirms valid YAML syntax; `actionlint` (installed via Homebrew for this pass) reports zero issues against the workflow file. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014h1TXJD8THZH4NbMqzrx97
Adds docs/README.md as a reviewer's map through the docs/ directory, grouped the way a reviewer actually needs it (Start Here / Architecture / Validation / Design Decisions / Development History / Everything Else) rather than the existing numeric 00-21 ordering, which reflects build chronology, not reading priority. Points to, rather than duplicates, every existing doc -- no content is copied or re-summarized. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014h1TXJD8THZH4NbMqzrx97
Drafts GitHub release notes for the v2_sih_mvp tag (already exists, pointing at cc8069e on main -- not moved, not recreated). NOT published: this commit only adds the draft file plus the exact `gh release create` command to publish it once reviewed. Content is restricted to claims already verified in docs/SIH_MVP_FREEZE.md -- project identity, real capabilities, measured metrics, demo commands, known limitations, and the hardware boundary, in that order, with no claim beyond what that document supports. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014h1TXJD8THZH4NbMqzrx97
The Working Demo caption overstated the image's provenance: apps/fsoc_demo.cpp does not use the Step-9 TrackingVisualizer overlay code. Corrects the claim to what's actually true (real Step-9 visualizer output from the deterministic C++ simulation) without overstating a shared code path that doesn't exist. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014h1TXJD8THZH4NbMqzrx97
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Polishes the public FSOC repository for SIH 2026 presentation without changing
the frozen MVP algorithms or runtime behavior.
Repository presentation
docs/DEVELOPMENT_HISTORY.mdCI
Repository hygiene
v1_baselineValidation