docs(agentex): use canonical agentex.protocol.acp import paths#254
Open
max-parke-scale wants to merge 1 commit into
Open
docs(agentex): use canonical agentex.protocol.acp import paths#254max-parke-scale wants to merge 1 commit into
max-parke-scale wants to merge 1 commit into
Conversation
Protocol-shape types (RPCMethod, CreateTaskParams, SendMessageParams, SendEventParams, CancelTaskParams) moved from agentex.lib.types.acp to the new canonical agentex.protocol.acp location in scaleapi/scale-agentex-python#371. The old path still works via a back-compat shim, but scaffolded user code following these docs should start on the canonical path. Updates: - 8 `from agentex.lib.types.acp import ...` imports in code samples - 2 `::: agentex.lib.types.acp.X` mkdocstrings references in API docs No content / behavior changes; same classes, new import path. The other lib/types/* modules (tracing, agent_card, credentials, etc.) stay on the old path because they have heavier transitive deps and weren't migrated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Merged
3 tasks
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
Updates the agentex mkdocs site to use the new canonical
agentex.protocol.acpimport paths for protocol-shape types (RPCMethod,CreateTaskParams,SendMessageParams,SendEventParams,CancelTaskParams).Companion to scaleapi/scale-agentex-python#371, which moved these types out of
agentex.lib.types.*into the new slim-safeagentex.protocol.*package. The old path still works via a back-compat shim — this PR isn't fixing a breakage, it's making sure scaffolded user code following these docs starts on the canonical path.Requested in a review comment on #371.
Changes
10 markdown files in
agentex/docs/:from agentex.lib.types.acp import ...→from agentex.protocol.acp import ...::: agentex.lib.types.acp.X→::: agentex.protocol.acp.Xagent_types/sync.mdandapi/types.md)No content / behavior changes; same classes, new import path.
What's not touched
Other
agentex.lib.types.*modules (tracing,agent_card,credentials,fastacp,llm_messages,converters) stay on the old path because they have heavier transitive deps and weren't migrated by #371. No doc references to those needed updates.Test plan
mkdocs serverenders without broken references.::: agentex.protocol.acp.SendMessageParamsresolve in the rendered HTML (mkdocstrings can find the symbol at the new path).Greptile Summary
This PR updates 10 markdown documentation files in
agentex/docs/to use the canonicalagentex.protocol.acpimport path instead of the legacyagentex.lib.types.acppath, companion to the Python SDK migration in scale-agentex-python#371.from agentex.lib.types.acp import ...withfrom agentex.protocol.acp import ....:::directives updated inagent_types/sync.md,agent_types/async/base.md,agent_types/async/temporal.md,acp/agentic/base.md,acp/agentic/temporal.md, andapi/types.mdto resolve symbols at the new path.agentex.lib.types.*modules (fastacp,tracing, etc.) are intentionally left unchanged as they were not part of the upstream migration.Confidence Score: 5/5
Safe to merge — all changes are documentation only, mechanically replacing one import path string with another across 10 markdown files.
Every change is a verbatim string substitution in doc code samples and mkdocstrings directives. The old path still works via a back-compat shim, so the docs remain accurate even before the new path resolves in a reader's environment. No runtime code is touched.
No files require special attention. The intentional omission of agentex.lib.types.fastacp and similar modules is clearly scoped and matches the upstream Python SDK migration.
Important Files Changed
:::directives fromagentex.lib.types.acptoagentex.protocol.acpforCreateTaskParams,SendEventParams, andCancelTaskParams.CreateTaskParams, SendEventParamsto the canonicalagentex.protocol.acppath.:::directives forCreateTaskParams,SendEventParams, andCancelTaskParams;AsyncACPConfigintentionally left on the old path per PR scope.:::directives forCreateTaskParamsandSendEventParams.:::directive forSendMessageParamsto the canonicalagentex.protocol.acppath.SendMessageParams,CreateTaskParams, andSendEventParamsto the canonicalagentex.protocol.acppath.:::directives forCreateTaskParams,SendMessageParams,SendEventParams, andCancelTaskParamsto the canonical path.SendEventParamsto the canonicalagentex.protocol.acppath.agentex.protocol.acp.SendEventParamsto the canonicalagentex.protocol.acppath in the OpenAI streaming integration example.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[Docs code samples & mkdocstrings] --> B{Import path} B -->|Before| C["agentex.lib.types.acp\n(back-compat shim)"] B -->|After this PR| D["agentex.protocol.acp\n(canonical path)"] C -.->|re-exports via shim| E[RPCMethod\nCreateTaskParams\nSendMessageParams\nSendEventParams\nCancelTaskParams] D --> E F["Other agentex.lib.types.*\n(fastacp, tracing, etc.)"] -->|unchanged — not migrated| G[Stays on old path]Reviews (1): Last reviewed commit: "docs(agentex): use canonical agentex.pro..." | Re-trigger Greptile