docs: align architecture, protocol, and module design docs#528
Draft
jinyu918 wants to merge 4 commits into
Draft
docs: align architecture, protocol, and module design docs#528jinyu918 wants to merge 4 commits into
jinyu918 wants to merge 4 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Closed
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
This PR aligns the repository design docs with the approved documentation updates and refreshes the architecture overview to match the current system framing.
It includes documentation-only changes in:
docs/protocol-design.mddocs/module-design.mddocs/architecture-overview.mdNo runtime code or protocol implementation was changed in this PR.
What changed
1. Protocol design alignment
Updated
docs/protocol-design.mdto reflect the approved protocol-level constraints and semantics, including:agent.settings.model.validateas a stable methodvalidated_config_hashexpected_validated_config_hashscreen_captureTask / Run source consistencyrun_status = completedplugin_runtime_statusandplugin_health_statusagent.delivery.openagent.task.artifact.openSecuritySummarybaseline2. Module design alignment
Updated
docs/module-design.mdto reflect the approved module-level design boundaries, including:/packages/protocol/schemasrequest_meta.trace_idTaskContextSnapshotSecuritySummaryservice model3. Architecture overview refresh
Updated
docs/architecture-overview.mdto better match the current system framing and improve readability at the architecture level.Main updates include:
TaskRunStepEventToolCallImpact
This PR is documentation-only.
It makes the architecture, protocol, and module design docs more consistent around:
Notes
These changes intentionally focus on approved documentation scope and architecture clarification.
Where the docs introduce stricter protocol expectations, follow-up implementation work may still be required in:
Validation