Repository navigation
docs: split interface contracts by source file - #158
Merged
Merged
Conversation
justinpettit
approved these changes
Jun 10, 2026
justinpettit
left a comment
justinpettit
left a comment
Collaborator
There was a problem hiding this comment.
LGTM
("questions" is misspelled as "questoins" in the commit message.)
`docs/interfaces.md` had grown into one large file covering every module's public surface. Agents either had to load the full file to answer narrow context questions, or waste tokens grepping for the answers they wanted. This commit instead places each module's interface contract in its own file under `context/interfaces/`, mirroring the `src/` tree, with `context/interfaces/README.md` as the entry point. Agents load the index, follow the link to the relevant per-source contract, and skip the rest.
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.
docs/interfaces.mdhad grown into one large file covering every module's public surface. Agents either had to load the full file to answer narrow context questoins, or waste tokens grepping for the answers they wanted.This commit instead places each module's interface contract in its own file under
context/interfaces/, mirroring thesrc/tree, withcontext/interfaces/README.mdas the entry point. Agents load the index, follow the link to the relevant per-source contract, and skip the rest.