docs(evidence): refresh EVIDENCE.md to v0.6.4 semantics + freshness tripwire#89
Merged
Merged
Conversation
…ripwire Refresh the artifact-contract doc where pre-0.6 wording went stale: - §4.5: all nine Verdict members (was a stale five) - §2: producer/read-only-consumer split (was a mislabeled 'five operations') - §4.2: paraphrase lineage preserves validity_score/validity_method - §4.1: cross-link cli_invocation provenance to its §6 semantic boundary - §4.5: oracle effects preserved through the verdict, not a separate payload Add tests/meta/test_evidence_doc_freshness.py: a coarse tripwire asserting every Verdict member and every read-only consumer is named in the doc. No runtime behavior changes.
ericckzhou
added a commit
that referenced
this pull request
Jun 7, 2026
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.
@
Refreshes the artifact-contract doc where pre-0.6 wording went stale, and adds a coarse anti-entropy tripwire so the contract cant silently drift again. No runtime behavior changes.
Why
docs/EVIDENCE.mdis the artifact contract — the document external readers trust about what a replay artifact is and what its verdicts claim. Stale claims there are higher-risk than a stale claim anywhere else in the repo. Several load-bearing places still carried pre-0.6 wording.Changes —
docs/EVIDENCE.mdVerdictmembers (was a stale five), pointing to the §7 claim table.run/minimizeproduce;replay,inspect,diff,history,timeline,matrix,verify,exportconsume), replacing a mislabeled "five operations" list that actually had six bullets.doctornamed as a diagnostic, not a protocol operation. Full command enumeration deliberately deferred toARCHITECTURE.mdto keep this doc protocol-level.paraphrasepreservesvalidity_score/validity_methodfor each accepted rewrite.cli_invocationprovenance cross-linked to its existing §6 semantic boundary rather than duplicated.New guard —
tests/meta/test_evidence_doc_freshness.pyCoarse tripwire: every
Verdictmember and every read-only consumer must be named in the doc. The docstring is explicit that this is not a prose validator — a document-wide substring scan cannot catch intra-document inconsistency (e.g. a stale per-section list while §7 stays complete); that class stays a review concern.Verification
uv run pytest tests/meta/→ 17 passeduv run ruff checkon the new test → clean@