Skip to content

Commit ad9fd39

Browse files
authored
docs: redesign README - remove About AXME, collapse diagrams, add footer (#43)
1 parent c10e02d commit ad9fd39

File tree

1 file changed

+22
-58
lines changed

1 file changed

+22
-58
lines changed

README.md

Lines changed: 22 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
# axme-conformance
22

3-
**Conformance suite for the AXME platform.** This repository contains the canonical contract test suite that validates spec-runtime-SDK parity across all API families, lifecycle invariants, and enterprise-boundary guarantees.
3+
**Conformance suite for the AXME platform.** Canonical contract test suite validating spec-runtime-SDK parity across all API families, lifecycle invariants, and enterprise-boundary guarantees.
44

5-
> **Alpha** · Conformance surface is expanding alongside the API. Not all families have full coverage yet.
6-
> Questions and conformance proposals → [[email protected]](mailto:[email protected])
5+
> **Alpha** - Conformance surface is expanding alongside the API. Not all families have full coverage yet.
76
8-
---
9-
10-
## About AXME
7+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
118

12-
AXME is a coordination infrastructure for durable execution of intents across services, agents, and humans.
13-
Learn more at [github.com/AxmeAI/axme](https://github.com/AxmeAI/axme).
9+
**[Docs](https://github.com/AxmeAI/axme-docs)** · **[axp-spec](https://github.com/AxmeAI/axp-spec)**
1410

1511
---
1612

1713
## Purpose
1814

19-
The conformance suite is the authoritative answer to: *"Does this implementation correctly implement the AXME protocol and public API contracts?"*
15+
Authoritative answer to: *"Does this implementation correctly implement the AXME protocol and public API contracts?"*
2016

21-
It validates:
17+
Validates:
2218

2319
- **API contract correctness** - request/response shapes, status codes, error semantics
2420
- **Lifecycle invariants** - state machine rules, terminal-state immutability, transition ordering
@@ -50,45 +46,12 @@ axme-conformance/
5046

5147
## Conformance Traceability
5248

53-
The traceability map shows how conformance checks are anchored to spec families, runtime behaviors, and SDK methods.
54-
55-
![Conformance Traceability Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/platform/04-conformance-traceability-map.svg)
56-
57-
*Each check cell links a spec contract (from `axme-spec`) to a runtime behavior (tested against `axme-control-plane`) and an SDK binding (tested per SDK). Green = passing, yellow = partial, red = failing or not yet implemented.*
58-
59-
---
60-
61-
<details>
62-
<summary><strong>Audit and Evidence</strong></summary>
63-
64-
Conformance results feed the audit trail. Every check run produces an evidence record that maps to the access control and policy enforcement layer.
65-
66-
![Audit Trail Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/08-audit-trail-map.svg)
67-
68-
*Audit evidence is structured: which check ran, against which endpoint, with which actor identity, what the result was. Evidence records are stored in the CI artifact archive.*
69-
70-
</details>
71-
72-
---
73-
74-
## Schema Compatibility Checks
75-
76-
Schema governance checks validate that schema changes in `axme-spec` do not introduce backward-incompatible breaks for existing consumers.
77-
78-
![Schema Governance and Compatibility](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/protocol/04-schema-governance-compatibility.svg)
79-
80-
*The compatibility check compares the new schema against all previously registered consumer versions. A breaking change fails the gate and requires a new schema version.*
81-
82-
---
49+
Each check links a spec contract (from `axp-spec`) to a runtime behavior and an SDK binding.
8350

8451
<details>
85-
<summary><strong>Resume, Controls, and Policy Conflict Resolution</strong></summary>
86-
87-
The most complex conformance domain covers the three-way conflict between a `resume` call, an in-flight `controls` update, and a `policy` mutation arriving at the same instant.
52+
<summary>Traceability map diagram</summary>
8853

89-
![Resume, Controls, and Policy Conflict Resolution](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/11-resume-controls-policy-conflict-resolution.svg)
90-
91-
*Conflict resolution rules: `resume` wins over `controls` if the intent is in a terminal `WAITING_*` state. `policy_generation` CAS prevents concurrent `policy` mutations from stomping each other. All conflicts are recorded in the audit trail.*
54+
![Conformance Traceability Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/platform/04-conformance-traceability-map.svg)
9255

9356
</details>
9457

@@ -114,7 +77,7 @@ AXME_GATEWAY_URL=https://your-gateway.example.com pytest
11477

11578
## Coverage Matrix
11679

117-
Coverage by API family: all D1 families (intents, inbox, approvals, webhooks) have full contract checks. Enterprise admin families (orgs, workspaces, service accounts, quotas) are covered. The `billing` family has schema contracts defined but no conformance checks yet - tracked for addition. Target for Alpha release: all D1 families at 100% pass rate.
80+
All D1 families (intents, inbox, approvals, webhooks) have full contract checks. Enterprise admin families (orgs, workspaces, service accounts, quotas) are covered. Target for Alpha release: all D1 families at 100% pass rate.
11881

11982
---
12083

@@ -124,28 +87,29 @@ A conformance check is considered passing only when it succeeds against:
12487

12588
1. The reference runtime (`axme-control-plane` staging)
12689
2. All five SDK clients (Python, TypeScript, Go, Java, .NET)
127-
3. The schema definitions in `axme-spec`
90+
3. The schema definitions in `axp-spec`
12891

12992
---
13093

131-
## Related Repositories
94+
## Related
13295

133-
| Repository | Relationship |
96+
| | |
13497
|---|---|
135-
| [axme-spec](https://github.com/AxmeAI/axme-spec) | Source of truth for contracts being validated |
98+
| [axp-spec](https://github.com/AxmeAI/axp-spec) | Source of truth for contracts being validated |
13699
| Control-plane runtime (private) | Primary runtime under test |
137-
| [axme-docs](https://github.com/AxmeAI/axme-docs) | Narrative documentation that conformance evidence supports |
138-
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK validated by this suite |
100+
| [axme-docs](https://github.com/AxmeAI/axme-docs) | Narrative documentation |
101+
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK |
139102
| [axme-sdk-typescript](https://github.com/AxmeAI/axme-sdk-typescript) | TypeScript SDK |
140103
| [axme-sdk-go](https://github.com/AxmeAI/axme-sdk-go) | Go SDK |
141104
| [axme-sdk-java](https://github.com/AxmeAI/axme-sdk-java) | Java SDK |
142105
| [axme-sdk-dotnet](https://github.com/AxmeAI/axme-sdk-dotnet) | .NET SDK |
143106

144107
---
145108

146-
## Contributing & Contact
109+
## Contributing
110+
111+
New conformance check proposals: open an issue with label `conformance-proposal`. See [CONTRIBUTING.md](CONTRIBUTING.md).
112+
113+
---
147114

148-
- New conformance check proposals: open an issue with label `conformance-proposal`
149-
- Quick Start: https://cloud.axme.ai/alpha/cli · Contact: [[email protected]](mailto:[email protected])
150-
- Security disclosures: see [SECURITY.md](SECURITY.md)
151-
- Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
115+
[[email protected]](mailto:[email protected]) · [Security](SECURITY.md) · [License](LICENSE)

0 commit comments

Comments
 (0)