docs: add the steering trio (STEERING.md, ADR.md, root CLAUDE.md) - #1
Merged
Conversation
Durable engineering context split three ways: docs/STEERING.md describes what the system is (boundaries, patterns, constraints) and points into architecture.md rather than duplicating it; docs/ADR.md records four long-standing decisions with their real alternatives (committed proto bindings, the offline-only suite, USB HID as the only transport, the additive domain model); CLAUDE.md at the root carries the working rules. None of these ship to PyPI - they exist only in the git tree.
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
Adds durable engineering context in three files with distinct jobs: docs/STEERING.md describes what the system is (boundaries, patterns, constraints) and points into architecture.md rather than duplicating it; docs/ADR.md records four long-standing decisions with the alternatives that lost and why; CLAUDE.md at the repo root carries the working rules an agent or contributor needs on every change. None of these ship to PyPI - they are not in the wheel's package dir or on the sdist include list, so they exist only in the git tree.
Changes
Test plan