Skip to content

fix(io): review follow-ups and usb-b-mini vocabulary expansion#541

Merged
jeffreylouden merged 1 commit into
mainfrom
fix/catalog-io/vocab-followups
Jul 13, 2026
Merged

fix(io): review follow-ups and usb-b-mini vocabulary expansion#541
jeffreylouden merged 1 commit into
mainfrom
fix/catalog-io/vocab-followups

Conversation

@jeffreylouden

@jeffreylouden jeffreylouden commented Jul 13, 2026

Copy link
Copy Markdown
Member

Summary

  • Applies the verified CodeRabbit findings from feat(io): standardize io types and enforce the vocabulary #539 that were left uncommitted when that PR merged: Bastl Klik clock output is type: clock; Mackie DLM12 Channel 1 is mic and Channel 2 is instrument (verified against the owner's manual — Ch1 has a mic/line switch, Ch2 accepts Hi-Z instrument sources); docs updated so E117 enforcement is described accurately and trs is no longer suggested as a connection value.
  • Expands the connection vocabulary with usb-b-mini, verified against the Bastl Klik manual ("Mini USB B Power 5V"), and canonicalizes variant spellings found in data: mini-usbusb-b-mini (Artiphon INSTRUMENT 1, verified mini-USB), trs1/4-inch and minijack1/8-inch (Xone:43).
  • Encodes the vocabulary policy in CLAUDE.md: enforcement catches mistakes, but a verified new signal type or connector grows the schema in the same PR instead of being force-fit onto a near-miss value.

Changes

File Type Action
data/hardware/bastl-instruments-klik.yaml hardware modified
data/hardware/mackie-dlm12.yaml hardware modified
data/hardware/artiphon-instrument-1.yaml hardware modified
data/hardware/allen-and-heath-xone43.yaml hardware modified
schema/io-connections.yaml schema modified
schema/io-types.yaml schema modified
schema/CONTEXT.md docs modified
docs/VALIDATION_ERRORS.md docs modified
CLAUDE.md docs modified

Validation

  • TypeScript type check passed
  • YAML schema validation passed (0 errors; advisory warnings dropped 554 → 546)
  • Translation validation passed
  • Formatting check passed
  • Database build successful (11,655 products)
  • URL health check passed (no new URLs in this change)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Clarified IO validation rules and connector terminology.
    • Updated guidance for standardized connection and signal types.
  • Data Updates

    • Corrected interface classifications for Bastl Klik and Mackie DLM12.
    • Standardized Xone:43 connector descriptions.
    • Added support for the usb-b-mini connection type and updated Artiphon Instrument 1 data.
  • Validation

    • IO type validation now strictly rejects unknown values, improving catalog data consistency.

Apply verified CodeRabbit findings from #539: Bastl Klik clock output
uses type clock; Mackie DLM12 channel 1 is mic and channel 2 is
instrument (per owner's manual); io-types clock comment drops the
connector reference; docs no longer suggest trs as a connection value;
CONTEXT.md and CLAUDE.md reflect that io type is enforced via E117.

Expand the connection vocabulary with usb-b-mini (verified against the
Bastl Klik manual), canonicalize mini-usb on the Artiphon INSTRUMENT 1,
and canonicalize trs/minijack on the Xone:43 to 1/4-inch and 1/8-inch.
Encode the expansion policy in CLAUDE.md: verified new values grow the
schema instead of being force-fit onto near-miss values.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: df87699

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
catalog Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added documentation Documentation updates schema Changes to catalog schemas hardware Changes to hardware catalog entries ready-for-review PR has passed all checks and is ready for review labels Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1436f8c2-c9dc-404b-9523-da6f192591bb

📥 Commits

Reviewing files that changed from the base of the PR and between 5c6b735 and df87699.

📒 Files selected for processing (10)
  • .changeset/spicy-jars-clap.md
  • CLAUDE.md
  • data/hardware/allen-and-heath-xone43.yaml
  • data/hardware/artiphon-instrument-1.yaml
  • data/hardware/bastl-instruments-klik.yaml
  • data/hardware/mackie-dlm12.yaml
  • docs/VALIDATION_ERRORS.md
  • schema/CONTEXT.md
  • schema/io-connections.yaml
  • schema/io-types.yaml

Walkthrough

The changes standardize hardware IO connection and type values, add usb-b-mini to the connection vocabulary, clarify E117 validation guidance, update authoring examples, and add a patch changeset.

Changes

IO vocabulary alignment

Layer / File(s) Summary
IO vocabulary and validation contracts
schema/io-connections.yaml, schema/io-types.yaml, schema/CONTEXT.md
Adds usb-b-mini to recognized connections and updates the documented clock type description.
Hardware IO declarations
data/hardware/allen-and-heath-xone43.yaml, data/hardware/artiphon-instrument-1.yaml, data/hardware/bastl-instruments-klik.yaml, data/hardware/mackie-dlm12.yaml
Canonicalizes connector values and corrects IO signal types across four hardware declarations.
Validation and authoring guidance
CLAUDE.md, docs/VALIDATION_ERRORS.md, .changeset/spicy-jars-clap.md
Documents strict type validation, clarifies connector guidance for E117, updates examples, and records a patch release.
Estimated code review effort: 2 (Simple) ~10 minutes

Possibly related PRs

🚥 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 matches the main changes: IO review follow-ups plus the usb-b-mini vocabulary expansion.
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 fix/catalog-io/vocab-followups

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

@jeffreylouden jeffreylouden merged commit 13a9cbe into main Jul 13, 2026
10 checks passed
@jeffreylouden jeffreylouden deleted the fix/catalog-io/vocab-followups branch July 13, 2026 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation updates hardware Changes to hardware catalog entries ready-for-review PR has passed all checks and is ready for review schema Changes to catalog schemas

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant