Skip to content

Commit c6eabc1

Browse files
George-iamclaude
andauthored
Clean up README for HN launch (#64)
- Consolidate duplicate Alpha banner into single blockquote - Add one-liner description after title - Wrap repository structure tree in collapsible details tag - Collapse Visualization Program section into details tag - Move local validation commands to Contributing section - Replace em dashes with regular dashes throughout Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4778361 commit c6eabc1

1 file changed

Lines changed: 41 additions & 31 deletions

File tree

README.md

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# axme-docs
22

3-
**Public documentation for the AXME platform**API references, protocol specifications, integration guides, security model, and the full visualization program.
3+
Implementation documentation, security model, API references, and architecture diagrams for the AXME platform.
44

5-
> **Alpha** · Protocol and API surface are stabilizing. Not recommended for production workloads yet.
6-
> **Alpha** — 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** - 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)
77
88
---
99

1010
## What Is AXME?
1111

1212
AXME is a coordination infrastructure for durable execution of long-running intents across distributed systems.
1313

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

16-
## AXP the Intent Protocol
16+
## AXP - the Intent Protocol
1717

18-
At the core of AXME is **AXP (Intent Protocol)** an open protocol that defines contracts and lifecycle rules for intent processing.
18+
At the core of AXME is **AXP (Intent Protocol)** - an open protocol that defines contracts and lifecycle rules for intent processing.
1919

2020
AXP can be implemented independently.
2121
The open part of the platform includes:
@@ -46,7 +46,8 @@ State and events can be accessed through:
4646

4747
---
4848

49-
## Repository Structure
49+
<details>
50+
<summary>Full repository structure</summary>
5051

5152
```
5253
axme-docs/
@@ -71,7 +72,7 @@ axme-docs/
7172
│ ├── examples-cloud-vs-protocol.md
7273
│ ├── external-integrator-dry-run.md
7374
│ ├── integration-quickstart.md
74-
│ ├── mcp-api-reference.md # MCP API reference all 48 tools, auth, response format
75+
│ ├── mcp-api-reference.md # MCP API reference - all 48 tools, auth, response format
7576
│ ├── mcp-axme-continuation-pattern.md
7677
│ ├── migration-and-deprecation-policy.md
7778
│ ├── migration-message-centric-to-intent-lifecycle.md
@@ -90,13 +91,15 @@ axme-docs/
9091
└── tests/
9192
```
9293

94+
</details>
95+
9396
---
9497

9598
## Platform Overview
9699

97100
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
98101

99-
![AXME System Context C4 Level 1](docs/diagrams/platform/01-system-context-c4.svg)
102+
![AXME System Context - C4 Level 1](docs/diagrams/platform/01-system-context-c4.svg)
100103

101104
*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.*
102105

@@ -110,9 +113,9 @@ Every intent progresses through a well-defined state machine. The diagram below
110113

111114
*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.*
112115

113-
The complete runtime container view services, databases, queues, and their connections:
116+
The complete runtime container view - services, databases, queues, and their connections:
114117

115-
![Container Runtime C4 Level 2](docs/diagrams/platform/02-container-runtime-c4.svg)
118+
![Container Runtime - C4 Level 2](docs/diagrams/platform/02-container-runtime-c4.svg)
116119

117120
*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.*
118121

@@ -127,13 +130,6 @@ The complete runtime container view — services, databases, queues, and their c
127130
- Cloud runnable: [axme-examples/examples](https://github.com/AxmeAI/axme-examples/tree/main/examples)
128131
- Protocol-only: [axme-examples/protocol](https://github.com/AxmeAI/axme-examples/tree/main/protocol)
129132

130-
```bash
131-
# Validate this documentation repo locally
132-
python -m pip install -e ".[dev]"
133-
python scripts/validate_docs.py
134-
pytest
135-
```
136-
137133
---
138134

139135
## Key Documents
@@ -145,20 +141,20 @@ pytest
145141
| [`security-overview.md`](docs/security-overview.md) | Security architecture, controls, and enterprise review baseline |
146142
| [`supported-limits-and-error-model.md`](docs/supported-limits-and-error-model.md) | Rate limits, quotas, error codes, retriability table |
147143
| [`migration-and-deprecation-policy.md`](docs/migration-and-deprecation-policy.md) | API versioning, deprecation timelines, migration guides |
148-
| [`mcp-api-reference.md`](docs/mcp-api-reference.md) | MCP Server all 48 tools, auth model, response format |
144+
| [`mcp-api-reference.md`](docs/mcp-api-reference.md) | MCP Server - all 48 tools, auth model, response format |
149145
| [`cross-org-receive-policy.md`](docs/cross-org-receive-policy.md) | Cross-org intent delivery: org policy + agent overrides |
150146
| [`agent-addressing.md`](docs/agent-addressing.md) | Agent address registry, agent:// URI scheme |
151147

152148
### API Family References
153149

154150
| Document | Scope |
155151
|---|---|
156-
| [`D1 Intents, Inbox, Approvals`](docs/public-api-families-d1-intents-inbox-approvals.md) | Intent CRUD, SSE, lifecycle events, human tasks |
157-
| [`D2 Webhooks, Capabilities`](docs/public-api-families-d2-webhooks-capabilities.md) | Webhook subscriptions, deliveries, event types |
158-
| [`D3 Users`](docs/public-api-families-d3-users.md) | User profiles, nicks, contacts |
159-
| [`D4 Invites, Media`](docs/public-api-families-d4-invites-media.md) | Invite links, media upload/download |
160-
| [`D5 Schemas`](docs/public-api-families-d5-schemas.md) | Schema governance, payload validation |
161-
| [`D6 Enterprise Governance`](docs/public-api-families-d6-enterprise-governance.md) | Orgs, workspaces, members, agents, policies, quotas |
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 |
162158

163159
---
164160

@@ -182,7 +178,7 @@ Idempotency and replay protection are first-class protocol features:
182178

183179
The platform enforces layered security boundaries. The trust boundary diagram maps each enforcement point:
184180

185-
![Security Trust Boundary DFD](docs/diagrams/security/03-trust-boundary-dfd.svg)
181+
![Security Trust Boundary - DFD](docs/diagrams/security/03-trust-boundary-dfd.svg)
186182

187183
*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.*
188184

@@ -196,13 +192,16 @@ Authentication and authorization enforcement flow:
196192

197193
---
198194

199-
## Visualization Program
195+
<details>
196+
<summary>Visualization program</summary>
200197

201198
The `docs/diagrams/` directory is the canonical home for all platform visualizations. Each diagram is available in four formats: `.mmd` (Mermaid source), `.dot` (Graphviz source), `.svg` (rendered vector), and `.png` (raster).
202199

203-
- **[Visualization Backlog & Status](docs/diagrams/VISUALIZATION_BACKLOG.md)** — P0 / P1 / P2 diagram inventory
204-
- **[Diagram Usage Matrix](docs/diagrams/DIAGRAM_USAGE_MATRIX.md)** — which diagrams appear in which repositories
205-
- **[Repository Distribution Plan](docs/diagrams/REPO_DISTRIBUTION_PLAN.md)** — placement strategy
200+
- **[Visualization Backlog & Status](docs/diagrams/VISUALIZATION_BACKLOG.md)** - P0 / P1 / P2 diagram inventory
201+
- **[Diagram Usage Matrix](docs/diagrams/DIAGRAM_USAGE_MATRIX.md)** - which diagrams appear in which repositories
202+
- **[Repository Distribution Plan](docs/diagrams/REPO_DISTRIBUTION_PLAN.md)** - placement strategy
203+
204+
</details>
206205

207206
---
208207

@@ -225,6 +224,17 @@ The `docs/diagrams/` directory is the canonical home for all platform visualizat
225224
## Contributing & Contact
226225

227226
- Bug reports and docs feedback: open an issue in this repository
228-
- Quick Start: https://cloud.axme.ai/alpha/cli · Contact: [hello@axme.ai](mailto:hello@axme.ai)
227+
- Quick Start: https://cloud.axme.ai/alpha/cli - Contact: [hello@axme.ai](mailto:hello@axme.ai)
229228
- Security disclosures: see [SECURITY.md](SECURITY.md)
230229
- Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
230+
231+
<details>
232+
<summary>Validate this documentation repo locally</summary>
233+
234+
```bash
235+
python -m pip install -e ".[dev]"
236+
python scripts/validate_docs.py
237+
pytest
238+
```
239+
240+
</details>

0 commit comments

Comments
 (0)