Repository navigation
docs(canonical): add contract surface ERRORS.md, EVENTS.md, and sync-docs manifest - #34
Open
jdjioe5-cpu wants to merge 1 commit into
Open
jdjioe5-cpu wants to merge 1 commit into
jdjioe5-cpu wants to merge 1 commit into
Conversation
…docs manifest - Add canonical docs/ERRORS.md covering all 32 active #[contracterror] codes with trigger conditions, caller guidance, and retired codes - Add canonical docs/EVENTS.md covering all 7 contract events with schema_version = 1, stroops scale, and payout snapshotting rationale - Update scripts/sync-docs.sh to sync ERRORS.md and EVENTS.md across code repositories - Reference ERRORS.md and EVENTS.md in docs/ARCHITECTURE_ESSENTIALS.md
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
2 participants
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.
Summary
Companion to Kinlock-Org/kinlock-contracts#34 (Roadmap row \M1-39, closes contracts #29).
This PR introduces the canonical versions of the contract surface reference documentation:
Verification