Skip to content

Commit e39ced9

Browse files
authored
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
1 parent d207cd7 commit e39ced9

4 files changed

Lines changed: 6 additions & 699 deletions

File tree

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Full runnable scenario set lives in:
131131

132132
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.
133133

134-
![API Method Family Map](docs/diagrams/01-api-method-family-map.svg)
134+
![API Method Family Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/api/01-api-method-family-map.svg)
135135

136136
*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.*
137137

@@ -141,7 +141,7 @@ The SDK covers the full public API surface organized into families. The map belo
141141

142142
From calling `create_intent()` to receiving a delivery confirmation — the full interaction sequence with the platform:
143143

144-
![Create and Control Sequence](docs/diagrams/02-create-and-control-sequence.svg)
144+
![Create and Control Sequence](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/02-create-and-control-sequence.svg)
145145

146146
*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.*
147147

@@ -151,7 +151,7 @@ From calling `create_intent()` to receiving a delivery confirmation — the full
151151

152152
Every mutating call in the SDK accepts an optional `idempotency_key`. Use it for all operations you might retry.
153153

154-
![Idempotency and Replay Protection](docs/diagrams/03-idempotency-and-replay-protection.svg)
154+
![Idempotency and Replay Protection](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/protocol/03-idempotency-and-replay-protection.svg)
155155

156156
*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.*
157157

@@ -221,9 +221,9 @@ The SDK docs folder contains diagrams for the API patterns used by this client:
221221

222222
| Diagram | Description |
223223
|---|---|
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 |
226-
| [`03-idempotency-and-replay-protection`](docs/diagrams/03-idempotency-and-replay-protection.svg) | Idempotency protocol |
224+
| [`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 |
226+
| [`03-idempotency-and-replay-protection`](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/protocol/03-idempotency-and-replay-protection.svg) | Idempotency protocol |
227227

228228
---
229229

@@ -277,7 +277,6 @@ axme-sdk-python/
277277
├── examples/
278278
│ └── basic_submit.py # Minimal language-native quickstart
279279
└── docs/
280-
└── diagrams/ # Diagram copies for README embedding
281280
```
282281

283282
---

docs/diagrams/01-api-method-family-map.svg

Lines changed: 0 additions & 276 deletions
This file was deleted.

0 commit comments

Comments
 (0)