Skip to content

docs: add a Song Editor guide with screenshots - #10

Open
ChrisBeWithYou wants to merge 2 commits into
mainfrom
docs/song-editor-section
Open

docs: add a Song Editor guide with screenshots#10
ChrisBeWithYou wants to merge 2 commits into
mainfrom
docs/song-editor-section

Conversation

@ChrisBeWithYou

Copy link
Copy Markdown
Collaborator

What

The Song Editor — the app's authoring tool, and the plugin behind every feedpak in the library — had no page of its own. Its only coverage was two thin generic pages under Song Files and feedpak, with no screenshots and no entry in the Plugin Directory. This adds a dedicated, user-facing guide.

  • New plugins/editor.md — a full walkthrough: open the editor, create a project (audio / chart / both, with auto-sync), the workspace, charting notes across the String / Piano roll / Notation views, tempo mapping, tracks + stems + the mixer, drums, save & build, shortcut profiles, and a troubleshooting table. Ten screenshots captured from a live build loaded with a clean, copyright-safe demo song.
  • Nav + Directory — listed under Plugins, and a new Authoring card in the Plugin Directory.
  • feedpak pages — rewrote feedpak/importing-tabs-editor.md to lead with the editor and list the supported import formats (Guitar Pro, MIDI, MusicXML, arrangement XML, audio, feedpak), and pointed feedpak/authoring.md at it.

Notes

  • Builds clean under mkdocs build --strict (no broken links, nav valid, all image refs resolve).
  • Screenshots are 1920×1080, 256-colour PNGs (~750 KB for the set).
  • Wording follows the repo Style Guide (FeedBack / feedpak / arrangement / plugin) and the Page Template (Short answer, sections, Common Problems table, Related Pages, Applies To).

🤖 Generated with Claude Code

https://claude.ai/code/session_0178CGdtptemWd4tUbjkYDhH

The Song Editor (the app's authoring tool) had no page of its own — its only
coverage was two thin generic pages under "Song Files and feedpak", with no
screenshots. This adds a dedicated, user-facing guide.

- New plugins/editor.md: open the editor, create a project (audio / chart /
  both, with auto-sync), the workspace, charting notes across the String /
  Piano roll / Notation views, tempo mapping, tracks + stems + the mixer,
  drums, save/build, shortcut profiles, and a troubleshooting table — with ten
  screenshots captured from a live build on a clean demo song.
- Listed it in the Plugins nav and added an "Authoring" card to the Plugin
  Directory.
- Rewrote feedpak/importing-tabs-editor.md to lead with the editor and list the
  supported import formats, and pointed feedpak/authoring.md at it.

Builds clean under `mkdocs build --strict`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0178CGdtptemWd4tUbjkYDhH
Signed-off-by: ChrisBeWithYou <chris@rifflarr.local>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@ChrisBeWithYou, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4afa7a79-1ef7-44a9-a109-735dc1155083

📥 Commits

Reviewing files that changed from the base of the PR and between 2abe11a and 58a346d.

⛔ Files ignored due to path filters (9)
  • docs/assets/screenshots/editor/drums.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/import.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/landing.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/mixer.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/notation.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/notes.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/pianoroll.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/tempomap.png is excluded by !**/*.png
  • docs/assets/screenshots/editor/workspace.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • docs/feedpak/authoring.md
  • docs/feedpak/importing-tabs-editor.md
  • docs/plugins/directory.md
  • docs/plugins/editor.md
  • mkdocs.yml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/song-editor-section

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.

…page

Accuracy fixes from a review against the plugin source:

- The mouse wheel PANS; Ctrl+wheel zooms, Alt+scroll stretches the piano-roll
  lanes; added the overview strip's double-click-to-fit.
- Tempo Map is reached with T,T (the first T opens the tool palette).
- The fretted piano roll isn't strictly read-only — you can add notes by
  sounding pitch and the resolver assigns the string/fret.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0178CGdtptemWd4tUbjkYDhH
Signed-off-by: ChrisBeWithYou <chris@rifflarr.local>
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