Skip to content

docs(readme): add usage steps and use the feedBack name - #12

Open
odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/usage-and-naming
Open

odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/usage-and-naming

Conversation

@odntht

@odntht odntht commented Oct 16, 2026

Copy link
Copy Markdown

What was wrong

  • The README had no usage steps. It listed what gets imported and the limitations, but not how to run an import or where the result ends up.
  • It never said that feedBack Desktop already bundles this plugin (feedBack-desktop/scripts/build-common.sh lists got-feedback/feedback-plugin-musicxml-import).
  • It used "FeedBack" where the org, the repo name and the other plugin READMEs use "feedBack".

What changed

New Usage section, written from the code:

  • Open it from the v3 Plugins page (plugins-page.js: clicking a pedal opens the plugin's screen).
  • The drop zone accepts .xml .musicxml .mxl (screen.html #mxi-dropzone).
  • Title and Composer are prefilled from /parse-arrangement (screen.js:100-101).
  • Include synthesized piano audio toggles the FluidSynth stem.
  • Build Feedpak writes <dlc>/musicxml/<title>_<composer>_mxml.feedpak and indexes it (routes.py build websocket: out_dir = Path(dlc) / 'musicxml', the out_name pattern, _meta_db.put).
  • Import Another resets the screen.

Plus the one-line bundled note and "FeedBack" → "feedBack" in prose (3 places). I didn't touch the license text.

Verification

  • curl -L https://github.com/got-feedback/feedpak-spec returns 200 (the existing link).
  • Every label was checked against screen.html / screen.js on main.

Docs only.

🤖 Generated with Claude Code

The README described what gets imported but not how to use the screen.
Add Usage steps taken from screen.html / screen.js / routes.py (drop
zone, prefilled title and composer, audio toggle, Build Feedpak, output
in <dlc>/musicxml/), note the plugin is bundled in feedBack Desktop, and
use the org's feedBack casing.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: odntht <odntht@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 16, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b2df1d79-d724-4f8d-8d47-b7abbc3ddefc
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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.

1 participant