Commit a453d47
docs(agentex): use canonical agentex.protocol.acp import paths (#254)
> **Stacked on
[#286](#286 (isolate
docs build from the workspace lock) — merge that first. This PR is only
the doc-path changes; #286 makes the doc build resolve
`agentex-sdk>=0.12.0` in an isolated env, so `agentex.protocol.*`
resolves without touching backend deps.
## Summary
Updates the agentex mkdocs site to use the new canonical
`agentex.protocol.acp` import paths for protocol-shape types
(`RPCMethod`, `CreateTaskParams`, `SendMessageParams`,
`SendEventParams`, `CancelTaskParams`).
Companion to
[scaleapi/scale-agentex-python#371](scaleapi/scale-agentex-python#371),
which moved these types out of `agentex.lib.types.*` into the new
slim-safe `agentex.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](scaleapi/scale-agentex-python#371 (review)).
## Changes
10 markdown files in `agentex/docs/`:
| Pattern | Count |
|---|---|
| `from agentex.lib.types.acp import ...` → `from agentex.protocol.acp
import ...` | 8 code samples |
| `::: agentex.lib.types.acp.X` → `::: agentex.protocol.acp.X` | 2
mkdocstrings cross-refs (in `agent_types/sync.md` and `api/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
- [x] Isolated `mkdocs build` renders green against `agentex-sdk` 0.12.0
(verified locally via the #286 build path).
- [x] `::: agentex.protocol.acp.*` mkdocstrings directives resolve at
the new path.
🧑💻🤖 — posted via [Claude Code](https://claude.com/claude-code)
<!-- claude-code -->
<!-- greptile_comment -->
<h3>Greptile Summary</h3>
This PR updates 10 documentation markdown files to use the new canonical
`agentex.protocol.acp` import paths, replacing the old
`agentex.lib.types.acp` references in both Python code samples and
mkdocstrings directives.
- Replaces `from agentex.lib.types.acp import ...` with `from
agentex.protocol.acp import ...` in 10 code sample blocks across 8
files.
- Updates 13 mkdocstrings `::: agentex.lib.types.acp.X` directives to
`::: agentex.protocol.acp.X` across 5 files, covering
`CreateTaskParams`, `SendMessageParams`, `SendEventParams`, and
`CancelTaskParams`.
- A grep confirms no remaining `agentex.lib.types.acp` references exist
anywhere in the docs tree after this PR.
<details><summary><h3>Confidence Score: 5/5</h3></summary>
Safe to merge — purely mechanical doc path updates with no remaining
old-path references in the docs tree.
All 23 occurrences of agentex.lib.types.acp across 10 files have been
correctly replaced with agentex.protocol.acp. A grep of the entire docs
directory confirms zero leftover old-path references. No logic,
behavior, or non-doc files are touched.
No files require special attention.
</details>
<h3>Important Files Changed</h3>
| Filename | Overview |
|----------|----------|
| agentex/docs/docs/api/types.md | 4 mkdocstrings directives updated
from old to new canonical path; no issues. |
| agentex/docs/docs/agent_types/async/base.md | 1 import and 3
mkdocstrings directives updated; no issues. |
| agentex/docs/docs/agent_types/async/temporal.md | 1 import and 2
mkdocstrings directives updated; no issues. |
| agentex/docs/docs/acp/agentic/base.md | 3 mkdocstrings directives
updated; no issues. |
| agentex/docs/docs/getting_started/project_structure.md | 3 import
statements updated across different agent-type examples; no issues. |
| agentex/docs/docs/agent_types/sync.md | 1 import and 1 mkdocstrings
directive updated; no issues. |
| agentex/docs/docs/api/overview.md | 1 import statement updated; no
issues. |
| agentex/docs/docs/concepts/streaming.md | 1 import statement updated;
no issues. |
| agentex/docs/docs/acp/agentic/temporal.md | 1 import statement
updated; no issues. |
| agentex/docs/docs/temporal_development/openai_integration.md | 1
import statement updated; no issues. |
</details>
<details><summary><h3>Flowchart</h3></summary>
```mermaid
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Doc code samples & mkdocstrings refs\n(10 markdown files)"] --> B{"Import path"}
B -- "Before" --> C["agentex.lib.types.acp\n(back-compat shim)"]
B -- "After" --> D["agentex.protocol.acp\n(canonical path)"]
D --> E["CreateTaskParams"]
D --> F["SendMessageParams"]
D --> G["SendEventParams"]
D --> H["CancelTaskParams"]
```
</details>
<sub>Reviews (5): Last reviewed commit: ["docs(agentex): use canonical
agentex.pro..."](5a42081)
| [Re-trigger
Greptile](https://app.greptile.com/api/retrigger?id=34170925)</sub>
<!-- /greptile_comment -->
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 94e7452 commit a453d47
10 files changed
Lines changed: 23 additions & 23 deletions
File tree
- agentex/docs/docs
- acp/agentic
- agent_types
- async
- api
- concepts
- getting_started
- temporal_development
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
157 | 157 | | |
158 | 158 | | |
159 | 159 | | |
160 | | - | |
| 160 | + | |
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
| |||
167 | 167 | | |
168 | 168 | | |
169 | 169 | | |
170 | | - | |
| 170 | + | |
171 | 171 | | |
172 | 172 | | |
173 | 173 | | |
| |||
177 | 177 | | |
178 | 178 | | |
179 | 179 | | |
180 | | - | |
| 180 | + | |
181 | 181 | | |
182 | 182 | | |
183 | 183 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
| 91 | + | |
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
| 54 | + | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
| |||
159 | 159 | | |
160 | 160 | | |
161 | 161 | | |
162 | | - | |
| 162 | + | |
163 | 163 | | |
164 | 164 | | |
165 | 165 | | |
| |||
169 | 169 | | |
170 | 170 | | |
171 | 171 | | |
172 | | - | |
| 172 | + | |
173 | 173 | | |
174 | 174 | | |
175 | 175 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
149 | | - | |
| 149 | + | |
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
| 45 | + | |
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
| 114 | + | |
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| |||
216 | 216 | | |
217 | 217 | | |
218 | 218 | | |
219 | | - | |
| 219 | + | |
220 | 220 | | |
221 | 221 | | |
222 | 222 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
149 | | - | |
| 149 | + | |
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
| |||
0 commit comments