docs: say anchors are ready for external commitment, not committed - #61
Merged
Conversation
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
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 this changes
Three sentences in
README.mdanddocs/index.mdsaid the event chain is "anchored outside your database". They now say the chain carries periodic anchors that you can commit outside your database.Why
The
tamper-evident-streamsspecification states that external anchoring is a seam, not a shipped integration: the framework records anchors and carries a field for an external commitment reference, and the consumer chooses the external target and submits to it. The concept page already says this; the README and the site landing page overclaimed. A reader who compares the two finds a promise the framework does not make.How it was verified
Docs only, no behaviour change, no spec delta. The governing guarantee is unchanged in
openspec/specs/tamper-evident-streams/spec.md(External anchoring is a seam, not a shipped integration)../scripts/local-gauntlet.shpasses