Appearance
Reference
The reference section is what you reach for when you know what you're looking for: the exact import path, the deprecation status of a name, the steps to migrate from one minor to the next.
Pages in this section
| Page | What it answers |
|---|---|
| Core subpath exports | Every @open-matrix/core/... subpath, what it exports, and when to use it. |
| Public API ledger | The canonical list of named exports from @open-matrix/core and @matrix/test-utils. |
| Deprecated APIs | What's marked @deprecated, when it goes away, and what to use instead. |
| Migration guides | Per-version walk-throughs for breaking changes. |
Where to look first
| If you want to know... | Read |
|---|---|
"What's the canonical import for MatrixActor?" | Core subpath exports |
| "Is symbol X stable?" | Public API ledger + Stability levels |
| "Is symbol X going away?" | Deprecated APIs |
| "How do I move from 0.0.x to 0.1.x?" | Migration guides |
Conventions
The SDK is on 0.x. The deprecation policy is described in Stability levels. Briefly:
- Public symbols are exported from the root barrel and/or a deep subpath in
package.json. - Deprecated symbols carry
@deprecatedJSDoc with the replacement. - Removal targets are listed in Deprecated APIs, expressed as minor versions.
- The wire protocol (
MxEnvelope, system ops, six declarations) is treated more strictly than the SDK surface — wire-breaking changes go through workstream review.
Source:
projects/matrix-3/packages/core/package.json:23-324(exports),projects/matrix-3/packages/core/src/index.ts(root barrel).