Fix root README's role, refresh Generator README for recent additions - #98
Merged
Merged
Conversation
The root README's "Features" section claimed keyboard/guitar/staff views, WebMIDI, and print support were shared between both tools - verified against the Finder's actual code (no matches for guitar/staff/keyboard-view markup, no WebMIDI, no print CSS) and its own README: none of that is true, they're Generator-only. Replaced with an accurate "What They Share" section and gave each project blurb above it a more specific summary, so the page does its actual job of routing a visitor to the right tool instead of half-describing one of them under a shared banner. Also fixed "no frameworks, no dependencies" in Technology, which stopped being true the day JSZip and WebMidi got vendored into the repo. The Generator's README hadn't caught up with this session's work: no mention of the bulk-download pack anywhere, the MPC-naming bullet still described the pre-fix behavior, and Under the Hood didn't know its own dependencies were vendored or that the pack is CI-built rather than committed. Added a section for the pack, refreshed the naming and dependency bullets, noted the CI theory audit, and listed the two new modules and the tools/vendor directories that didn't exist when this file was last touched. While verifying the "173 progressions / 34 scales / 22 genres" claims against the actual source data (all confirmed accurate), found and fixed a pre-existing internal inconsistency unrelated to this session's work: the Quick Start section said 133 progressions and 4 variants where the rest of the document says 173 and five, and one bullet said 60+ genre-intelligent progressions against 100+ everywhere else (actual count is 99, confirmed from the palettePriorities data) - converged all of it on the verified numbers. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EwQCigYZxdGBW3kPWnMMgF
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Root README: its "Features" section claimed keyboard/guitar/staff views, WebMIDI, and print support were shared between both tools. Verified against the Finder's actual code (no matches for guitar/staff/keyboard-view markup anywhere in its
index.html, no WebMIDI, no print CSS) and its own README - none of that is true, all of it is Generator-only. Replaced with an accurate "What They Share" section and tightened each project blurb, so the page does its actual job of routing a visitor to the right tool rather than half-describing one of them under a shared banner. Also fixed "no frameworks, no dependencies" in the Technology section, which stopped being true the day JSZip and WebMidi got vendored into the repo.Generator README: hadn't caught up with this session's work - no mention of the bulk-download pack anywhere, the MPC-naming bullet still described the pre-fix behavior, "Under the Hood" didn't know its own dependencies were vendored or that the pack is CI-built rather than committed. Added a section for the pack, refreshed the naming and dependency bullets, noted the CI theory audit (verified it actually runs and actually checks what I claimed, not just that the script exists), and listed the two new modules (
generation.js,mpcNaming.js) plus thetools//vendor/directories that didn't exist when this file was last touched.Bonus fix, unrelated to this session's other work: while verifying the "173 progressions / 34 scales / 22 genres" claims against the actual source data (all confirmed accurate by counting them directly), found the Quick Start section still said 133 progressions and 4 variants against 173/five everywhere else in the same document, and one bullet said 60+ genre-intelligent progressions against 100+ everywhere else (actual count is 99, confirmed from the
palettePrioritiesdata). Converged all of it on the verified numbers.Test plan
index.htmlfor guitar/staff/keyboard-view markup and WebMIDI usage - none found, confirming the root README's prior claims were wrongmodules/musicTheory.jsrather than trusting the existing prose.github/workflows/check-theory.ymlto confirm the CI theory audit genuinely runs on relevant pushes/PRs before claiming so in the READMEgrepswept both files afterward for the old inconsistent numbers (133, 60+) - none remain🤖 Generated with Claude Code
https://claude.ai/code/session_01EwQCigYZxdGBW3kPWnMMgF
Generated by Claude Code