feedBack/docs
Kris Anderson 1246c290f1
docs: add real-time scoring + hit-feedback pipeline docs
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)
2026-06-17 23:41:43 -07:00
..
benchmarks Clean release snapshot 2026-06-16 18:47:13 +02:00
diagnostics Clean release snapshot 2026-06-16 18:47:13 +02:00
skills Clean release snapshot 2026-06-16 18:47:13 +02:00
3dhighway-open-string-double-sustain.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-domains.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-recipes.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-review-preflight.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-roadmap.md Clean release snapshot 2026-06-16 18:47:13 +02:00
capability-safety-matrix.md Clean release snapshot 2026-06-16 18:47:13 +02:00
diagnostics-bundle-spec.md Clean release snapshot 2026-06-16 18:47:13 +02:00
library.png Clean release snapshot 2026-06-16 18:47:13 +02:00
NOTE_FAILURE_PLAN.md Clean release snapshot 2026-06-16 18:47:13 +02:00
NOTE_FAILURE_SPEC.md Clean release snapshot 2026-06-16 18:47:13 +02:00
note-detect-tuning.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:04 +02:00
note-state-provider.md docs: add real-time scoring + hit-feedback pipeline docs 2026-06-17 23:41:43 -07:00
player-2d.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
player-3d.jpg Clean release snapshot 2026-06-16 18:47:13 +02:00
player-3d.webp Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-capability-inventory.md Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-manifest.schema.json Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-styles.md Clean release snapshot 2026-06-16 18:47:13 +02:00
plugin-v3-ui.md Clean release snapshot 2026-06-16 18:47:13 +02:00
realtime-scoring-pipeline.md docs: add real-time scoring + hit-feedback pipeline docs 2026-06-17 23:41:43 -07:00
sloppak-hand-editing.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:04 +02:00
sloppak-spec.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:04 +02:00
visualization-feedback-guide.md docs: add real-time scoring + hit-feedback pipeline docs 2026-06-17 23:41:43 -07:00