Skip to content

Rewrite README for the FeedBack rename and current feature set - #20

Merged
OmikronApex merged 2 commits into
mainfrom
docs/readme-refresh
Jul 8, 2026
Merged

Rewrite README for the FeedBack rename and current feature set#20
OmikronApex merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@gionnibgud

@gionnibgud gionnibgud commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Rewrite README for the FeedBack rename and current feature set

Tiny, standalone docs cleanup — no code touched, can be reviewed/merged
independently of any other open branch/PR in any order.

Why

The README still read as the pre-rename slopsmith-plugin-staffview:

  • Title/org referenced "Slopsmith" throughout.
  • A "Requires: a Slopsmith build with the sloppak notation schema... the
    feat/notation-schema-v1 branch" callout pointing at a branch that's long
    since merged.
  • A "Playback mode" section describing the alphaSynth transport pill,
    which was dropped from the plugin back in Drop alphaSynth playback; fix empty-measure rests and click-to-seek #4.

What changed

Rewrote it to describe what the plugin actually does today:

  • Corrected org/product references (FeedBack, not Slopsmith).
  • The full options pill: NOTE DETECTION, STUDY, HAND, MIDI, LAYOUT, ZOOM.
  • MIDI input scoring via the core midi-input / note-detection domains.
  • Miss-dot overlay, the core stats/HUD bridge (+ HUD repositioning).
  • Monitor synth (WebAudioFont).
  • Study mode, explicitly noted as unscored practice (doesn't feed the
    live HUD / song_stats).
  • Note explorer, OGG loop.
  • Added a ## Tests section (the plugin now has a full node:test suite —
    there wasn't one before).
  • Kept the original origin-story credit line.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README to reflect the plugin’s current FeedBack-focused identity and capabilities.
    • Expanded the “How it works” section with clearer explanations for activation, scoring/rendering, and configuration persistence.
    • Documented practice enhancements, including MIDI-keyboard scoring, miss indicators, live stats/HUD updates, monitor audio, study mode behavior, and note exploration interactions.
    • Clarified install steps and runtime loading guidance.
    • Added/updated a testing section describing the available node-based helper test suite.

The README still read as the pre-rename slopsmith-plugin-staffview: wrong org
name, a stale "Requires: a Slopsmith build" callout pointing at a merged
branch, and a "Playback mode" (alphaSynth transport pill) section that was
dropped from the plugin long ago (PR #4).

Replaces it with what the plugin actually does today: the full options pill
(NOTE DETECTION, STUDY, HAND, MIDI, LAYOUT, ZOOM), MIDI input scoring via the
core note-detection domain, the miss-dot overlay, the core stats/HUD bridge,
the monitor synth, study mode's unscored-practice design, note explorer, and
OGG loop. Adds a Tests section (the plugin now has a full node:test suite).
Keeps the origin-story credit line, generalized off the retired org name.

Independent of any other open branch — README-only, no code touched.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: gionnibgud <gionnibgud@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 85698159-b539-4c37-af81-0b6b95e850b6

📥 Commits

Reviewing files that changed from the base of the PR and between d0dffbc and e955afd.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md is rewritten to describe the FeedBack Staff View plugin, replacing prior Slopsmith-focused content. Changes include an expanded "How it works" section, a new "Practice features" section, updated installation instructions, a new "Tests" section, and revised license text.

Changes

README content update

Layer / File(s) Summary
Intro, features, and install sections
README.md
Replaces the header and "How it works" narrative with FeedBack/Staff View content, adding auto-activation, WebSocket-based scoring, OGG playback details, and a new "Practice features" section; updates installation instructions to reference FeedBack's plugins/ folder.
Tests and License sections
README.md
Adds a "Tests" section describing a browser-free host-integration test suite run via npm test, and updates the "License" section text and attribution.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: byrongamatos

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README rewrite for the FeedBack rename and updated feature set.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-refresh

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 44-46: The final fenced command block in README.md is missing a
language tag, so update that markdown fence to be labeled as shell to satisfy
markdownlint. Locate the fenced snippet containing the npm test command and add
the shell language identifier to the fence so the block is explicitly treated as
a shell snippet.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 40a7a113-e15f-42bd-b8ac-ddabbeb065cf

📥 Commits

Reviewing files that changed from the base of the PR and between 1151657 and d0dffbc.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@gionnibgud

Copy link
Copy Markdown
Contributor Author

Supersedes #1 — that PR fixes one URL's casing (got-feedback/feedbackgot-feedback/feedBack); this rewrite includes that same fix (using the properly-cased org, got-feedBack) plus the rest of the file (title, org/product prose, the dead alphaSynth "Playback mode" section, current feature set). Once this merges, #1 should be closed rather than rebased — there's nothing left in it to land.

CodeRabbit review on #20: the closing command block was an unlabeled fence,
which markdownlint flags (MD040, fenced-code-language).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: gionnibgud <gionnibgud@gmail.com>
@OmikronApex

Copy link
Copy Markdown
Contributor

Code review

Docs-only PR — verified README claims against the code.

Verified accurate:

Minor (non-blocking):

  • "curated into the org for the piano/keys epic" drops the old issue ref (slopsmith#828); fine if those refs are dead post-rename, just noting the link is lost.
  • The Tests section says "host-integration helpers", but the suite also covers MIDI message parsing (tests/midi.test.js) — slightly narrow wording, cosmetic.

Note: the copyright line removal was flagged and explicitly accepted by the maintainer.

LGTM.

🤖 Generated with Claude Code

@OmikronApex
OmikronApex merged commit 88b9775 into main Jul 8, 2026
3 checks passed
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