Skip to content

docs: add contract.yaml cheatsheet reference and monitor-alert-escalate pattern (#29, #30) - #31

Merged
Skull-boy merged 1 commit into
Skull-boy:mainfrom
ghzhost:feat/contract-reference-and-pattern
Sep 2, 2026
Merged

Skull-boy merged 1 commit into
Skull-boy:mainfrom
ghzhost:feat/contract-reference-and-pattern

Conversation

@ghzhost

@ghzhost ghzhost commented Sep 2, 2026

Copy link
Copy Markdown

Summary

This PR addresses and resolves issues #29 and #30 by providing essential developer documentation and an architectural pattern guide.

Changes Included:

  1. docs/contract-reference.md (Closes [Docs] Write a contract.yaml field reference cheatsheet #30):

    • Fast, single-page reference table covering all contract.yaml (v1.1) fields: version/contract_version, system, lifecycle, inputs, outputs, permissions, side_effects, approval_points/approvals, recovery, replay, dependencies, state, observability, risk, and security.
    • Outlines required status, semantics, minimal practical syntax examples, and common pitfalls/mistakes for each field.
    • Includes a minimal valid contract.yaml template passing schema validation with inline comments for rapid onboarding.
  2. patterns/monitor-alert-escalate.md (Closes [Pattern] Document the Monitor-Alert-Escalate pattern #29):

    • Comprehensive pattern document for continuous observation, anomaly detection, and human escalation workflows.
    • Follows standard repo pattern format: Intent, When to use it, When NOT to use it, ASCII structure flow, Contract requirements, and Known implementations (competitor-feature-parity-watcher).

Verification:

  • All 60 test suite cases (pytest) pass successfully.
  • Minimal template verified against scyvera.validate_contract().

…te pattern

- Add docs/contract-reference.md covering all contract fields with descriptions, examples, common mistakes and minimal valid contract (closes Skull-boy#30)
- Add patterns/monitor-alert-escalate.md documenting the continuous monitoring and tiered escalation pattern (closes Skull-boy#29)
@Skull-boy
Skull-boy merged commit f18f79f into Skull-boy:main Sep 2, 2026
2 checks passed
@Skull-boy Skull-boy added the documentation Improvements or additions to documentation label Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Write a contract.yaml field reference cheatsheet [Pattern] Document the Monitor-Alert-Escalate pattern

2 participants