docs: specify the scene format as a protocol-level contract#5
Merged
Conversation
New docs-site chapter (scene-protocol.md): protocol stance (strict unknown-field rejection, deterministic semantics, no dead fields, machine discoverability, text-native), semver-bound stability rules (additive-only, no repurposing, byte-identical output for existing scenes), extension gates, normative compile semantics (channels, patterns, transform order, event ordering), and the error contract. Wire it into SUMMARY, the machine-interface stability contract, the agent skill reference, and the roadmap capability list. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
What
Elevates the scene format from "documented YAML" to a protocol-level contract, with a new normative docs-site chapter:
scene-protocol.md.The scene file is the wire format between a composing agent and the compiler — the input half of the machine contract, as
machine-interface.mdis the invocation half.Chapter contents
scorekit schema), text-native.pan/reverb/glide), channel allocation, the five pattern algorithms, transform order, and the canonical event ordering that is the byte-determinism guarantee.Wiring
SUMMARY.md: new chapter after Quick Startmachine-interface.md: stability contract now references the scene protocolskills/scorekit/reference.md: points to the normative spec (and bumps "verified against" to v0.2)docs/roadmap.md: capability list notes the protocol-level contractDocs-only change;
mdbook build docs-sitepasses locally. All facts cross-checked againstscorekit schemaoutput andsrc/schema.rs/src/composer.rs.