You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
refactor(diagrams): switch to raw GitHub URLs from axme-docs (#29)
Replace all local SVG copies with raw.githubusercontent.com URLs
pointing to the canonical source in axme-docs/docs/diagrams/.
- All diagram images now always reflect the latest version
- Removes 2-9 duplicate SVG files per repo
- No more stale copies when diagrams are updated in axme-docs
- The docs/diagrams/ directory is removed where it contained only SVGs
Diagrams source of truth: AxmeAI/axme-docs/docs/diagrams/
Made-with: Cursor
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,7 +131,7 @@ Full runnable scenario set lives in:
131
131
132
132
The SDK covers the full public API surface organized into families. The map below shows all method groups and how they relate to the platform's intent lifecycle.
133
133
134
-

134
+

135
135
136
136
*Each family corresponds to a segment of the lifecycle or an operational domain. Intents and inbox are D1 (core). Approvals, schemas, and media are D2. Enterprise admin and service accounts are D3.*
137
137
@@ -141,7 +141,7 @@ The SDK covers the full public API surface organized into families. The map belo
141
141
142
142
From calling `create_intent()` to receiving a delivery confirmation — the full interaction sequence with the platform:
143
143
144
-

144
+

145
145
146
146
*The SDK sets the `Idempotency-Key` and `X-Correlation-Id` headers automatically. The gateway validates, persists, and returns the intent in `PENDING` state. The scheduler picks it up and drives delivery.*
147
147
@@ -151,7 +151,7 @@ From calling `create_intent()` to receiving a delivery confirmation — the full
151
151
152
152
Every mutating call in the SDK accepts an optional `idempotency_key`. Use it for all operations you might retry.
153
153
154
-

154
+

155
155
156
156
*Duplicate requests with the same key return the original response without re-executing. Keys expire after 24 hours. The SDK will warn if you reuse a key with different parameters.*
157
157
@@ -221,9 +221,9 @@ The SDK docs folder contains diagrams for the API patterns used by this client:
221
221
222
222
| Diagram | Description |
223
223
|---|---|
224
-
|[`01-api-method-family-map`](docs/diagrams/01-api-method-family-map.svg)| Full API family overview |
225
-
|[`02-create-and-control-sequence`](docs/diagrams/02-create-and-control-sequence.svg)| Intent creation and control flow |
|[`01-api-method-family-map`](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/api/01-api-method-family-map.svg)| Full API family overview |
225
+
|[`02-create-and-control-sequence`](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/02-create-and-control-sequence.svg)| Intent creation and control flow |
0 commit comments