This repository owns the canonical Aomi documentation, built with Mintlify. Pages are MDX; docs.json defines navigation, redirects, and the interactive OpenAPI reference.
| Area | Start here |
|---|---|
| TypeScript client | Client SDK |
| Agent turns and events | Agent |
| Portable transaction Builds | Pipeline |
| Authentication and App credentials | Authentication |
| Wallet review and durable Commits | Wallet and signing |
| CLI | CLI reference |
| MCP | MCP setup |
| Rust plugin authoring | Rust SDK |
| HTTP resources | API reference |
| Packaged widget | Widget installation |
aomi-labs/aomi:packages/clientowns the TypeScript client and CLI; the React and widget packages own browser integration.aomi-labs/aomi-sdk: Rust plugin-authoring SDK, macros, test helpers, and example Apps.aomi-labs/product-mono: backend routes and generated OpenAPI contracts.
Verify examples against the relevant source and installed package declarations. Merged source, published npm/crate versions, and hosted deployment availability are separate facts. Mark examples that require a newer release; do not document open PRs as available features.
Use the Mintlify CLI to preview and validate the site. Check MDX compilation, internal links, and JSON examples. Type-check complete TypeScript examples against the installed client; document host-provided UI callbacks and wallet adapters in partial examples. Validate Rust examples against the pinned SDK version.
Keep old page paths as concise pointers when replacing retired API or SDK guidance. Read AGENTS.md for terminology and content boundaries.