Conversation
Expand module design docs to a consistent detailed structure aligned with agent detailed docs and current implementation contracts. Key changes: - Reworked module READMEs to explicitly include public interfaces, core fields, and runtime flows. - Added transport module main design entrypoint at docs/design/modules/transport/README.md. - Appended explicit contract/field/flow snapshots to long-form context, hook, tool, and agent docs. - Updated docs/design/modules/README.md index to reflect the new transport entrypoint and detail standard. - Rewrote docs/design/Interfaces.md as a synced cross-module contract table derived from current kernel/interfaces/types. Rationale: - Reduce ambiguity between design docs and code signatures. - Make cross-module integration points auditable and easier to review. - Provide a single authoritative interface map for future implementation and refactor work.
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.
Expand module design docs to a consistent detailed structure aligned with agent detailed docs and current implementation contracts.
Key changes:
Rationale:
Summary
Scope (One PR One Thing)
Changed Files (required)
List all touched files and why each file changed.
If this PR is a large diff (>300 changed lines), explain why split PRs are not possible and provide a split follow-up plan.
Acceptance Criteria
Test Evidence (required)
.........If this PR changes high-risk runtime paths (auth/concurrency/execution control), include
risk-matrixevidence.Risk and Rollback
Dependency and Lockfile Changes
requirements.txt/pyproject.toml/package.json): [ ] Yes [ ] No [ ] N/AAgent Rules Checklist (required)
Reference:
docs/agent_rules.mdskip/only/excludeusage is explained and reviewed