docs: drop the hand-written cross-SDK parity protocol - #1
Merged
Merged
Conversation
The generated mesh block from fc/scripts/gen-mesh.mjs now carries the repo map, the shared-surface definition, the ripple order and the protocol. The hand-written section said the same thing in its own words, so each guide carried two protocols that could drift apart. Keep the generated block as the single source and drop the duplicate. The repository-specific conventions above it are unaffected.
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
Removes the hand-written
## Cross-SDK parity protocoland### Current parity baselinesections from this repo's agent guide.Why
Those sections and the generated
<!-- MESH:START -->block fromfc/scripts/gen-mesh.mjswere written independently, hours apart, and saynearly the same thing: the repo map, what counts as a shared surface, and the
protocol to run before calling a shared-surface change done.
Two protocols in one file is worse than either alone — they drift, and an agent
reading the guide has to decide which one governs. The generated block wins: it
is driven by
fc/mesh.json, covers all seven repos, and regenerates when theregistry changes. The hand-written copy cannot.
Nothing unique is lost. The parity fact it carried — Go and Python ship the same
surface and the same nine examples — already lives in the registry's
selfLinefor each SDK.
Scope
CLAUDE.mdis reworded, since it advertised thesections being removed.