Skip to content

docs: add S17 articulation-aware guitar rendering - #128

Closed
PhysShell wants to merge 4 commits into
mainfrom
agent/s17-articulation-aware-rendering
Closed

PhysShell wants to merge 4 commits into
mainfrom
agent/s17-articulation-aware-rendering

Conversation

@PhysShell

Copy link
Copy Markdown
Owner

What changed

Adds a new planned roadmap stage:

  • S17 — Articulation-aware guitar rendering
  • updates docs/SPEC.md so optional audio audition remains a derived view over the canonical symbolic score
  • updates the README roadmap range and removes the misleading absolute no audio synthesis wording

Stage contract

S17 is explicitly an optional audition/rendering layer:

canonical Score
  -> GuitarPerformanceCompiler
  -> GuitarPerformancePlan
  -> versioned ArticulationProfile
  -> SamplerBackend
  -> optional AmpBackend
  -> audition audio

Planned slices cover:

  1. renderer/asset/licence audit;
  2. semantic performance plan and profile schema;
  3. external offline SFZ POC with a user-supplied bank;
  4. cockpit audition integration;
  5. embedded realtime sampler only after the POC proves useful;
  6. optional amp/cabinet chain;
  7. optional legally redistributable demo instrument.

Boundaries

  • canonical Score remains source truth
  • no Guitar Pro RSE assets or reverse-engineered banks
  • no bank-specific keyswitch constants in griff-core
  • no sample bank bundled merely because it is free to download
  • no change to S6/S7 ranking, S8 feedback, S9 learning, or S10's MIDI-oriented CLAP contract
  • unsupported articulations produce explicit loss/approximation records
  • renderer provenance is captured at render start, never reconstructed from mutable UI state

Prior art posture

The stage records SFZ/sfizz and Neural Amp Modeler only as candidates for a future Slice-0 audit. No dependency or asset is adopted by this docs-only PR.

Validation

Docs-only change. Reviewed the rendered Markdown and cross-links. No production code or tests changed.

Known acceptance item

Before this roadmap entry is accepted/merged, append the matching S17 definition to docs/glossary.md §0, which remains the canonical numbering source. The connector used for this branch only supports whole-file replacement for existing files, so this large append-only constitution file was deliberately not rewritten blindly.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9045fee2-064e-4da3-8a47-0f86681a5ba8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/s17-articulation-aware-rendering

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.

Copy link
Copy Markdown
Owner Author

Closing as a premature roadmap-stage allocation. The idea is not the problem;
the route is.

This branch does not add a document — it moves the project's boundary. In
docs/SPEC.md it rewrites "MIDI in → MIDI out, no audio synthesis" into
"MIDI in → MIDI out today" plus a planned audio renderer, adds a thirteenth
hard rule, and changes the canonical span from S0 … S16 to S0 … S17. That is
a scope decision about what griff is, not a stage write-up.

Two process points make it un-mergeable in this form rather than merely
debatable:

  • AGENTS.md says stage numbering follows docs/glossary.md §0 only and that
    labels are never improvised. This branch allocates S17 while the glossary
    acceptance item it depends on is still open — the branch says so itself.
  • The repository's own lifecycle puts undecided work in docs/proposals/, and
    a stage doc is where accepted scope lands. This skips both the proposal and
    the ADR that a change to SPEC.md's hard rules would need.

On main today, S17 appears exactly once: as an exclusion in a milestone scope
note ("no S17 rendering"). Allocating the number now would invert that with no
decision behind it.

The better shape for this material is a proposal, revisited when a renderer POC
exists and the question "does this deserve its own stage?" can be answered from
something other than the document's own confidence. A stage number should follow
a decision, not precede it.


Generated by Claude Code

@PhysShell PhysShell closed this Aug 17, 2026
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