Docs carry the shape of the system, not its status
MIZAN.md's phase-numbered implementation order, PRODUCT_ARCHITECTURE's "Deferred until Render revenue funds it" and "Shipped in", PSR_VS_EDGE's current-state section, and the READMEs' passing-test counts were all reporting where the work stood rather than what the system is. OWED_SURFACE keeps its subject — surface that is specified but unbuilt — stated as the shape each unit owes. The channel sections follow the renamed slots: Params / ClientMessage / ServerMessage, and Channel as the base class on both backends. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -12,11 +12,9 @@ npm install @rythazhur/mizan@git+https://git.impactsoundworks.com/isw/mizan.git#
|
||||
|
||||
You don't use this package directly. You use the **generated hooks**.
|
||||
|
||||
This is the pre-kernel React adapter: it ships its own `MizanProvider`
|
||||
(`src/context.tsx`) that owns HTTP/WebSocket/CSRF/session/context state
|
||||
directly, rather than subscribing to the `@mizan/base` kernel. It is still
|
||||
the provider the Django + desktop example wires against. (`DjangoContext`,
|
||||
`useDjango`, etc. are deprecated aliases for the `Mizan*` names.)
|
||||
This React adapter ships its own `MizanProvider` (`src/context.tsx`) that owns
|
||||
HTTP/WebSocket/CSRF/session/context state directly, rather than subscribing to
|
||||
the `@mizan/base` kernel.
|
||||
|
||||
### 1. Configure
|
||||
|
||||
@@ -77,7 +75,7 @@ chat.messages // typed, reactive
|
||||
## Generated Files
|
||||
|
||||
The Rust codegen emits per-target files into the configured `output`
|
||||
directory (Stage 1 is auto-included whenever `react` is a target):
|
||||
directory:
|
||||
|
||||
| File | Contents |
|
||||
|------|----------|
|
||||
@@ -85,7 +83,7 @@ directory (Stage 1 is auto-included whenever `react` is a target):
|
||||
| `contexts/<name>.ts` | Per-context `fetchXxx` bundles |
|
||||
| `react.tsx` | `<MizanContext>` provider + typed `use{Hook}()` hooks |
|
||||
| `channels.ts` / `channels.hooks.tsx` | Channel types + hooks (when the schema carries channels) |
|
||||
| `index.ts` | Stage 1 re-export root |
|
||||
| `index.ts` | Re-export root |
|
||||
|
||||
## Sub-exports
|
||||
|
||||
|
||||
Reference in New Issue
Block a user