mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-10-02 11:11:47 +00:00
Kris AndersonandBret Mogilefsky
1246c290f1
Three new docs in docs/ that consolidate the path from audio detection through to the highway, plus small cross-links in CLAUDE.md for discoverability. - realtime-scoring-pipeline.md: end-to-end trace with diagrams and a concrete chord-strum example walked through every layer (engine, IPC, note_detect, highway core, renderer). - note-state-provider.md: full reference for setNoteStateProvider / bundle.getNoteState (slopsmith#254). Return values, alpha ownership, the time_string_fret keying convention, 'hit' vs 'active' sustain semantics, common pitfalls. - visualization-feedback-guide.md: practical walkthrough for a plugin author adding hit feedback to a custom viz. Minimal 2D Canvas example plus a troubleshooting decision tree. The note-state provider contract was previously documented in three places with different angles and assumed cross-reading. These docs consolidate it into one coherent narrative + focused API reference + how-to. The pipeline doc also documents the engine-verifier path (audio:setChart / audio:getNoteVerdicts) which was previously only described in NoteVerifier source comments. Companion PR against byrongamatos/slopsmith-desktop covers the engine-side internals. Signed-off-by: Kris Anderson <topkoa@gmail.com> (cherry picked from commit c8ec371813bf36c686f1884f3b2340f4a94f11a8)
