Repository navigation
Conversation
Lead with the behavior contract (responses, stored state, effects) and the behavior lane (CODE -> VERIFY -> SHIP), using the relabeled verification-loop and system-boundary diagrams. Move Playwright and Feature files into a short "Writing contracts today" section and mark the external-repository setup path as unavailable until the npm release.
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.
Summary
Stacked on #232. Reframes the README around what the system does rather than how it is built: engineers should not need to know how their system is implemented, only how it behaves.
Scope and links
chore/readme-behavior-contractdocs/readme-alpha-status(docs: reposition the README and add alpha status #232)Type of change
Validation and evidence
npx prettier@3.9.9 --check README.mdREADME.mddocs/alpha-status.mdis unchanged; the six other diagrams indocs/assets/readme/stay unreferenced.Security impact
Independent review evidence
🤖 Generated with Claude Code