Skip to content

Commit 010300f

Browse files
authored
Redesign README: docs-first, remove AXME intro, key documents prominent (#65)
* redesign README: docs-first structure, remove AXME intro, key documents prominent * fix: rename axme-spec -> axp-spec across all references * docs: move 6 inline diagrams from README into context-appropriate docs README now has 1 diagram (System Context C4). Intent lifecycle moved to D1 intents doc, container runtime to enterprise-runtime doc, trust boundary and auth flow to security-overview, protocol envelope and idempotency to integration-quickstart.
1 parent c6eabc1 commit 010300f

18 files changed

Lines changed: 184 additions & 230 deletions

README.md

Lines changed: 59 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,74 @@
11
# axme-docs
22

3-
Implementation documentation, security model, API references, and architecture diagrams for the AXME platform.
3+
Implementation docs, API reference, security model, and architecture diagrams for the AXME platform.
44

5-
> **Alpha** - Protocol and API surface are stabilizing. Not recommended for production workloads yet.
6-
> Install CLI, log in, run your first example in under 5 minutes. [Quick Start](https://cloud.axme.ai/alpha/cli) - [hello@axme.ai](mailto:hello@axme.ai)
5+
[![Alpha](https://img.shields.io/badge/status-alpha-orange)](https://cloud.axme.ai/alpha/cli)
6+
[![License](https://img.shields.io/badge/license-see%20LICENSE-blue)](LICENSE)
7+
8+
[Quick Start](https://cloud.axme.ai/alpha/cli) · [axme](https://github.com/AxmeAI/axme) · [Spec](https://github.com/AxmeAI/axp-spec) · [Examples](https://github.com/AxmeAI/axme-examples)
79

810
---
911

10-
## What Is AXME?
12+
## Integration Quickstart
1113

12-
AXME is a coordination infrastructure for durable execution of long-running intents across distributed systems.
14+
1. **Install the CLI and run your first example**: https://cloud.axme.ai/alpha/cli
15+
2. Choose your SDK: [Python](https://github.com/AxmeAI/axme-sdk-python) · [TypeScript](https://github.com/AxmeAI/axme-sdk-typescript) · [Go](https://github.com/AxmeAI/axme-sdk-go) · [Java](https://github.com/AxmeAI/axme-sdk-java) · [.NET](https://github.com/AxmeAI/axme-sdk-dotnet)
16+
3. Follow `docs/integration-quickstart.md` for the full onboarding path
17+
4. Example hubs:
18+
- Cloud runnable: [axme-examples/examples](https://github.com/AxmeAI/axme-examples/tree/main/examples)
19+
- Protocol-only: [axme-examples/protocol](https://github.com/AxmeAI/axme-examples/tree/main/protocol)
1320

14-
It provides a model for executing **intents** - requests that may take minutes, hours, or longer to complete - across services, agents, and human participants.
21+
---
1522

16-
## AXP - the Intent Protocol
23+
## Key Documents
1724

18-
At the core of AXME is **AXP (Intent Protocol)** - an open protocol that defines contracts and lifecycle rules for intent processing.
25+
| Document | Description |
26+
|---|---|
27+
| [`integration-quickstart.md`](docs/integration-quickstart.md) | End-to-end onboarding path for new integrators |
28+
| [`public-api-auth.md`](docs/public-api-auth.md) | Authentication: platform API keys, actor tokens, JWT validation |
29+
| [`security-overview.md`](docs/security-overview.md) | Security architecture, controls, and enterprise review baseline |
30+
| [`supported-limits-and-error-model.md`](docs/supported-limits-and-error-model.md) | Rate limits, quotas, error codes, retriability table |
31+
| [`migration-and-deprecation-policy.md`](docs/migration-and-deprecation-policy.md) | API versioning, deprecation timelines, migration guides |
32+
| [`mcp-api-reference.md`](docs/mcp-api-reference.md) | MCP Server - all 48 tools, auth model, response format |
33+
| [`cross-org-receive-policy.md`](docs/cross-org-receive-policy.md) | Cross-org intent delivery: org policy + agent overrides |
34+
| [`agent-addressing.md`](docs/agent-addressing.md) | Agent address registry, agent:// URI scheme |
1935

20-
AXP can be implemented independently.
21-
The open part of the platform includes:
36+
### API Family References
2237

23-
- the protocol specification and schemas
24-
- SDKs and CLI for integration
25-
- conformance tests
26-
- implementation and integration documentation
38+
| Document | Scope |
39+
|---|---|
40+
| [`D1 - Intents, Inbox, Approvals`](docs/public-api-families-d1-intents-inbox-approvals.md) | Intent CRUD, SSE, lifecycle events, human tasks |
41+
| [`D2 - Webhooks, Capabilities`](docs/public-api-families-d2-webhooks-capabilities.md) | Webhook subscriptions, deliveries, event types |
42+
| [`D3 - Users`](docs/public-api-families-d3-users.md) | User profiles, nicks, contacts |
43+
| [`D4 - Invites, Media`](docs/public-api-families-d4-invites-media.md) | Invite links, media upload/download |
44+
| [`D5 - Schemas`](docs/public-api-families-d5-schemas.md) | Schema governance, payload validation |
45+
| [`D6 - Enterprise Governance`](docs/public-api-families-d6-enterprise-governance.md) | Orgs, workspaces, members, agents, policies, quotas |
2746

28-
Without AXME Cloud runtime, these open components are still usable for protocol-compatible implementations and validation.
47+
---
2948

30-
## AXME Cloud
49+
## Platform Overview
3150

32-
**AXME Cloud** is the managed service that runs AXP in production together with **The Registry** (identity and routing).
51+
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
3352

34-
It removes operational complexity by providing:
53+
![AXME System Context - C4 Level 1](docs/diagrams/platform/01-system-context-c4.svg)
3554

36-
- reliable intent delivery and retries
37-
- lifecycle management for long-running operations
38-
- handling of timeouts, waits, reminders, and escalation
39-
- observability of intent status and execution history
55+
*The gateway is the single public entry point. Intents flow from SDK clients through TLS to the gateway, which routes them into the durable scheduler and connector layer. Webhooks and MCP callbacks leave the platform from the connector side, cryptographically signed.*
4056

41-
State and events can be accessed through:
57+
---
4258

43-
- API and SDKs
44-
- event streams and webhooks
45-
- the cloud console
59+
## Related Repositories
60+
61+
| Repository | Role |
62+
|---|---|
63+
| [axp-spec](https://github.com/AxmeAI/axp-spec) | Canonical schema and protocol contracts |
64+
| Control-plane runtime (private) | Internal runtime implementation |
65+
| [axme-conformance](https://github.com/AxmeAI/axme-conformance) | Conformance and contract test suite |
66+
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK |
67+
| [axme-sdk-typescript](https://github.com/AxmeAI/axme-sdk-typescript) | TypeScript SDK |
68+
| [axme-sdk-go](https://github.com/AxmeAI/axme-sdk-go) | Go SDK |
69+
| [axme-sdk-java](https://github.com/AxmeAI/axme-sdk-java) | Java SDK |
70+
| [axme-sdk-dotnet](https://github.com/AxmeAI/axme-sdk-dotnet) | .NET SDK |
71+
| [axme-cli](https://github.com/AxmeAI/axme-cli) | Command-line interface |
4672

4773
---
4874

@@ -93,105 +119,6 @@ axme-docs/
93119

94120
</details>
95121

96-
---
97-
98-
## Platform Overview
99-
100-
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
101-
102-
![AXME System Context - C4 Level 1](docs/diagrams/platform/01-system-context-c4.svg)
103-
104-
*The gateway is the single public entry point. Intents flow from SDK clients through TLS to the gateway, which routes them into the durable scheduler and connector layer. Webhooks and MCP callbacks leave the platform from the connector side, cryptographically signed.*
105-
106-
---
107-
108-
## Intent Lifecycle
109-
110-
Every intent progresses through a well-defined state machine. The diagram below shows all states, transitions, and terminal outcomes.
111-
112-
![Intent Lifecycle State Machine](docs/diagrams/intents/01-intent-lifecycle-state-machine.svg)
113-
114-
*Key states: `PENDING → PROCESSING → WAITING_* → DELIVERED → RESOLVED`. Any intent can be cancelled or expire at most transition points. Retry loops are bounded by the policy envelope.*
115-
116-
The complete runtime container view - services, databases, queues, and their connections:
117-
118-
![Container Runtime - C4 Level 2](docs/diagrams/platform/02-container-runtime-c4.svg)
119-
120-
*Gateway (public REST API), agent-core (workflow engine), auth service, MCP platform (48 JSON-RPC tools), and tool registry run as Cloud Run services sharing a PostgreSQL instance. The scheduler runs on the gateway via internal tick endpoints.*
121-
122-
---
123-
124-
## Integration Quickstart
125-
126-
1. **Install the CLI and run your first example**: https://cloud.axme.ai/alpha/cli
127-
2. Choose your SDK: [Python](https://github.com/AxmeAI/axme-sdk-python) · [TypeScript](https://github.com/AxmeAI/axme-sdk-typescript) · [Go](https://github.com/AxmeAI/axme-sdk-go) · [Java](https://github.com/AxmeAI/axme-sdk-java) · [.NET](https://github.com/AxmeAI/axme-sdk-dotnet)
128-
3. Follow `docs/integration-quickstart.md` for the full onboarding path
129-
4. Example hubs:
130-
- Cloud runnable: [axme-examples/examples](https://github.com/AxmeAI/axme-examples/tree/main/examples)
131-
- Protocol-only: [axme-examples/protocol](https://github.com/AxmeAI/axme-examples/tree/main/protocol)
132-
133-
---
134-
135-
## Key Documents
136-
137-
| Document | Description |
138-
|---|---|
139-
| [`integration-quickstart.md`](docs/integration-quickstart.md) | End-to-end onboarding path for new integrators |
140-
| [`public-api-auth.md`](docs/public-api-auth.md) | Authentication: platform API keys, actor tokens, JWT validation |
141-
| [`security-overview.md`](docs/security-overview.md) | Security architecture, controls, and enterprise review baseline |
142-
| [`supported-limits-and-error-model.md`](docs/supported-limits-and-error-model.md) | Rate limits, quotas, error codes, retriability table |
143-
| [`migration-and-deprecation-policy.md`](docs/migration-and-deprecation-policy.md) | API versioning, deprecation timelines, migration guides |
144-
| [`mcp-api-reference.md`](docs/mcp-api-reference.md) | MCP Server - all 48 tools, auth model, response format |
145-
| [`cross-org-receive-policy.md`](docs/cross-org-receive-policy.md) | Cross-org intent delivery: org policy + agent overrides |
146-
| [`agent-addressing.md`](docs/agent-addressing.md) | Agent address registry, agent:// URI scheme |
147-
148-
### API Family References
149-
150-
| Document | Scope |
151-
|---|---|
152-
| [`D1 - Intents, Inbox, Approvals`](docs/public-api-families-d1-intents-inbox-approvals.md) | Intent CRUD, SSE, lifecycle events, human tasks |
153-
| [`D2 - Webhooks, Capabilities`](docs/public-api-families-d2-webhooks-capabilities.md) | Webhook subscriptions, deliveries, event types |
154-
| [`D3 - Users`](docs/public-api-families-d3-users.md) | User profiles, nicks, contacts |
155-
| [`D4 - Invites, Media`](docs/public-api-families-d4-invites-media.md) | Invite links, media upload/download |
156-
| [`D5 - Schemas`](docs/public-api-families-d5-schemas.md) | Schema governance, payload validation |
157-
| [`D6 - Enterprise Governance`](docs/public-api-families-d6-enterprise-governance.md) | Orgs, workspaces, members, agents, policies, quotas |
158-
159-
---
160-
161-
## Protocol
162-
163-
AXP wraps every intent in a signed envelope. The protocol layer ensures integrity, ordering, and schema version negotiation.
164-
165-
![AXP Protocol Envelope](docs/diagrams/protocol/01-protocol-envelope.svg)
166-
167-
*The envelope carries the intent payload, sender identity, schema version, idempotency key, and a gateway-applied HMAC signature. Recipients verify the signature before processing.*
168-
169-
Idempotency and replay protection are first-class protocol features:
170-
171-
![Idempotency and Replay Protection](docs/diagrams/protocol/03-idempotency-and-replay-protection.svg)
172-
173-
*Duplicate requests bearing the same idempotency key return the cached response without re-executing. Replay attacks are rejected by the nonce registry.*
174-
175-
---
176-
177-
## Security Model
178-
179-
The platform enforces layered security boundaries. The trust boundary diagram maps each enforcement point:
180-
181-
![Security Trust Boundary - DFD](docs/diagrams/security/03-trust-boundary-dfd.svg)
182-
183-
*Public-facing TLS terminates at the gateway. Internal service calls use mTLS. Data at rest is encrypted with AES-256-GCM. Webhook payloads carry HMAC-SHA256 signatures.*
184-
185-
Security control baseline for enterprise review: [`docs/security-overview.md`](docs/security-overview.md).
186-
187-
Authentication and authorization enforcement flow:
188-
189-
![Auth/Authz Enforcement](docs/diagrams/security/01-authn-authz-enforcement-flow.svg)
190-
191-
*API key verification → JWT validation → org/workspace scope check → role-based access → resource-level policy grant evaluation. All steps are audited.*
192-
193-
---
194-
195122
<details>
196123
<summary>Visualization program</summary>
197124

@@ -205,31 +132,12 @@ The `docs/diagrams/` directory is the canonical home for all platform visualizat
205132

206133
---
207134

208-
## Related Repositories
135+
## Contributing
209136

210-
| Repository | Role |
211-
|---|---|
212-
| [axme-spec](https://github.com/AxmeAI/axme-spec) | Canonical schema and protocol contracts |
213-
| Control-plane runtime (private) | Internal runtime implementation |
214-
| [axme-conformance](https://github.com/AxmeAI/axme-conformance) | Conformance and contract test suite |
215-
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK |
216-
| [axme-sdk-typescript](https://github.com/AxmeAI/axme-sdk-typescript) | TypeScript SDK |
217-
| [axme-sdk-go](https://github.com/AxmeAI/axme-sdk-go) | Go SDK |
218-
| [axme-sdk-java](https://github.com/AxmeAI/axme-sdk-java) | Java SDK |
219-
| [axme-sdk-dotnet](https://github.com/AxmeAI/axme-sdk-dotnet) | .NET SDK |
220-
| [axme-cli](https://github.com/AxmeAI/axme-cli) | Command-line interface |
221-
222-
---
223-
224-
## Contributing & Contact
225-
226-
- Bug reports and docs feedback: open an issue in this repository
227-
- Quick Start: https://cloud.axme.ai/alpha/cli - Contact: [hello@axme.ai](mailto:hello@axme.ai)
228-
- Security disclosures: see [SECURITY.md](SECURITY.md)
229-
- Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
137+
Bug reports and docs feedback: open an issue in this repository.
230138

231139
<details>
232-
<summary>Validate this documentation repo locally</summary>
140+
<summary>Validate locally</summary>
233141

234142
```bash
235143
python -m pip install -e ".[dev]"
@@ -238,3 +146,7 @@ pytest
238146
```
239147

240148
</details>
149+
150+
---
151+
152+
[hello@axme.ai](mailto:hello@axme.ai) · [@axme_ai](https://x.com/axme_ai) · [Security](SECURITY.md) · [License](LICENSE)

docs/diagrams/DIAGRAM_USAGE_MATRIX.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Legend:
1212
| --- | --- | --- |
1313
| `intents/01-intent-lifecycle-state-machine.svg` | `axme-control-plane` | `axme-examples` |
1414
| `intents/02-create-and-control-sequence.svg` | `axme-cli` | `axme-sdk-python` |
15-
| `intents/03-policy-anatomy.svg` | `axme-control-plane` | `axme-spec` |
15+
| `intents/03-policy-anatomy.svg` | `axme-control-plane` | `axp-spec` |
1616
| `intents/04-waiting-branches-and-wakeups.svg` | `axme-control-plane` | `axme-conformance` |
1717
| `intents/05-delivery-and-processing-pipeline.svg` | `axme-control-plane` | `axme-infra` |
1818
| `intents/06-internal-scheduler-loop.svg` | `axme-control-plane` | `axme-infra` |
1919
| `intents/07-access-control-matrix.svg` | `axme-security-ops` | `axme-control-plane` |
2020
| `intents/08-audit-trail-map.svg` | `axme-conformance` | `axme-security-ops` |
21-
| `intents/09-intent-payload-extensibility-and-semantic-schemas.svg` | `axme-spec` | `axme-docs` |
21+
| `intents/09-intent-payload-extensibility-and-semantic-schemas.svg` | `axp-spec` | `axme-docs` |
2222
| `intents/10-human-in-loop-approval-branches.svg` | `axme-reference-clients` | `axme-mobile` |
2323
| `intents/11-resume-controls-policy-conflict-resolution.svg` | `axme-conformance` | `axme-reference-clients` |
2424

@@ -29,7 +29,7 @@ Legend:
2929
| `platform/01-system-context-c4.svg` | `axme-docs` | `axme-cloud-landing` |
3030
| `platform/02-container-runtime-c4.svg` | `axme-control-plane` | `axme-infra` |
3131
| `platform/03-enterprise-placement-and-boundaries.svg` | `axme-docs` | `axme-reference-clients` |
32-
| `platform/04-conformance-traceability-map.svg` | `axme-conformance` | `axme-spec` |
32+
| `platform/04-conformance-traceability-map.svg` | `axme-conformance` | `axp-spec` |
3333

3434
## API
3535

@@ -38,16 +38,16 @@ Legend:
3838
| `api/01-api-method-family-map.svg` | `axme-sdk-typescript` | `axme-sdk-python` |
3939
| `api/02-error-model-retriability.svg` | `axme-sdk-go` | `axme-sdk-dotnet` |
4040
| `api/03-pagination-filtering-sorting-patterns.svg` | `axme-sdk-java` | `axme-sdk-dotnet` |
41-
| `api/04-rate-limit-and-quota-model.svg` | `axme-cli` | `axme-spec` |
41+
| `api/04-rate-limit-and-quota-model.svg` | `axme-cli` | `axp-spec` |
4242

4343
## Protocol
4444

4545
| diagram | primary_repo | secondary_repo |
4646
| --- | --- | --- |
47-
| `protocol/01-protocol-envelope.svg` | `axme-spec` | `axme-sdk-typescript` |
48-
| `protocol/02-versioning-and-deprecation-flow.svg` | `axme-spec` | `axme-docs` |
47+
| `protocol/01-protocol-envelope.svg` | `axp-spec` | `axme-sdk-typescript` |
48+
| `protocol/02-versioning-and-deprecation-flow.svg` | `axp-spec` | `axme-docs` |
4949
| `protocol/03-idempotency-and-replay-protection.svg` | `axme-sdk-python` | `axme-sdk-typescript` |
50-
| `protocol/04-schema-governance-compatibility.svg` | `axme-spec` | `axme-conformance` |
50+
| `protocol/04-schema-governance-compatibility.svg` | `axp-spec` | `axme-conformance` |
5151
| `protocol/05-transport-selection-and-fallbacks.svg` | `axme-examples` | `axme-docs` |
5252

5353
## Security
@@ -58,7 +58,7 @@ Legend:
5858
| `security/02-crypto-key-lifecycle.svg` | `axme-security-ops` | `axme-infra` |
5959
| `security/03-trust-boundary-dfd.svg` | `axme-security-ops` | `axme-docs` |
6060
| `security/04-secrets-management-rotation-flow.svg` | `axme-security-ops` | `axme-infra` |
61-
| `security/05-webhook-signature-verification.svg` | `axme-control-plane` | `axme-spec` |
61+
| `security/05-webhook-signature-verification.svg` | `axme-control-plane` | `axp-spec` |
6262
| `security/06-threat-model-stride-map.svg` | `axme-local-internal` | `axme-security-ops` |
6363
| `security/07-data-classification-and-encryption-zones.svg` | `axme-security-ops` | `axme-docs` |
6464

docs/diagrams/REPO_DISTRIBUTION_PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Reference matrix:
1212

1313
- `axme-docs`
1414
- canonical source and catalog for all diagram packs.
15-
- `axme-spec`
15+
- `axp-spec`
1616
- protocol and API diagrams (envelope/versioning/idempotency/error/compatibility).
1717

1818
### Runtime and reliability

docs/diagrams/platform/04-conformance-traceability-map.dot

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ digraph conformance {
33
node [shape=box style=filled fillcolor="#dbeafe" fontname="Helvetica" fontsize=11];
44
edge [fontname="Helvetica" fontsize=10];
55

6-
SPEC [label="axme-spec\n(schemas + OpenAPI)" fillcolor="#1e40af" fontcolor=white];
6+
SPEC [label="axp-spec\n(schemas + OpenAPI)" fillcolor="#1e40af" fontcolor=white];
77
SDK [label="axme-sdk-*\n(SDK tests)"];
88
CONF [label="axme-conformance\n(conformance suite)"];
99
CP [label="axme-control-plane\n(runtime)"];

docs/diagrams/platform/04-conformance-traceability-map.mmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
flowchart LR
2-
SPEC[axme-spec\nschemas + OpenAPI]
2+
SPEC[axp-spec\nschemas + OpenAPI]
33

44
SPEC --> SDK[axme-sdk-*\nSDK tests]
55
SPEC --> CONF[axme-conformance\nconformance suite]

docs/enterprise-runtime-model-and-placement.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,17 @@ Temporary compatibility behavior:
135135
5. Confirm intent routing details, usage ledger records, and admin audit events include tenant scope.
136136
6. Promote to production after staging verification is green.
137137

138+
## Container Runtime View
139+
140+
The complete runtime container view - services, databases, queues, and their connections:
141+
142+
![Container Runtime - C4 Level 2](diagrams/platform/02-container-runtime-c4.svg)
143+
144+
Gateway (public REST API), agent-core (workflow engine), auth service, MCP platform (48 JSON-RPC tools), and tool registry run as Cloud Run services sharing a PostgreSQL instance. The scheduler runs on the gateway via internal tick endpoints.
145+
138146
## References
139147

140148
- `docs/public-api-families-d6-enterprise-governance.md`
141149
- `docs/enterprise-scoped-credentials-migration-note.md`
142150
- `docs/openapi/gateway.track-f-sprint1.v1.json`
143-
- `axme-spec/schemas/public_api/`
151+
- `axp-spec/schemas/public_api/`

docs/examples-cloud-vs-protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AXME follows an **open protocol + managed runtime** model.
99

1010
You can still use:
1111

12-
- AXP protocol spec (`axme-spec`)
12+
- AXP protocol spec (`axp-spec`)
1313
- SDKs as protocol/client helpers
1414
- CLI for contract-level checks and endpoint testing
1515
- conformance suite (`axme-conformance`) for compatibility validation

docs/external-integrator-dry-run.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Provide a repeatable public-only verification that a third-party integrator can
66

77
## Required Public Inputs
88

9-
- `axme-spec/docs/public-api-schema-index.md`
10-
- `axme-spec/docs/schema-versioning-rules.md`
11-
- `axme-spec/docs/protocol-error-status-model.md`
12-
- `axme-spec/docs/idempotency-correlation-rules.md`
9+
- `axp-spec/docs/public-api-schema-index.md`
10+
- `axp-spec/docs/schema-versioning-rules.md`
11+
- `axp-spec/docs/protocol-error-status-model.md`
12+
- `axp-spec/docs/idempotency-correlation-rules.md`
1313
- `axme-docs/docs/public-api-auth.md`
1414
- `axme-docs/docs/supported-limits-and-error-model.md`
1515
- `axme-docs/docs/migration-and-deprecation-policy.md`
@@ -44,7 +44,7 @@ Provide a repeatable public-only verification that a third-party integrator can
4444

4545
For each dry-run execution, capture:
4646

47-
- date and commit SHAs of `axme-spec` and `axme-docs`,
47+
- date and commit SHAs of `axp-spec` and `axme-docs`,
4848
- implemented endpoints and payload contracts,
4949
- validation result summary,
5050
- observed issues/gaps and linked follow-up items (if any).

0 commit comments

Comments
 (0)