@xmachines/docs 1.0.0-beta.45 → 1.0.0-beta.48

package/examples/README.md

@@ -74,39 +74,38 @@ npm run dev -w @xmachines/play-dom-router-demo
 
 ### Core
 
-| Package                   | Role                                                        |
-| ------------------------- | ----------------------------------------------------------- |
-| `@xmachines/play-xstate`  | `definePlayer`, `formatPlayRouteTransitions`, `PlayerActor` |
-| `@xmachines/play-actor`   | `AbstractActor`, `typedSpec`                                |
-| `@xmachines/play-signals` | TC39 Signals polyfill, `watchSignal`                        |
-| `@xmachines/play-router`  | `extractMachineRoutes`, `getRoutableRoutes`                 |
+| Package                                                               | Role                                                        |
+| --------------------------------------------------------------------- | ----------------------------------------------------------- |
+| [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md)   | `definePlayer`, `formatPlayRouteTransitions`, `PlayerActor` |
+| [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md)     | `AbstractActor`, `typedSpec`                                |
+| [`@xmachines/play-signals`](../api/@xmachines/play-signals/README.md) | TC39 Signals polyfill, `watchSignal`                        |
+| [`@xmachines/play-router`](../api/@xmachines/play-router/README.md)   | `extractMachineRoutes`, `getRoutableRoutes`                 |
 
 ### Renderers
 
-| Package                  | Role                                |
-| ------------------------ | ----------------------------------- |
-| `@xmachines/play-dom`    | `connectRenderer`, `defineRegistry` |
-| `@xmachines/play-react`  | `PlayRenderer`, `defineRegistry`    |
-| `@xmachines/play-solid`  | `PlayRenderer`, `defineRegistry`    |
-| `@xmachines/play-svelte` | `PlayRenderer`, `defineRegistry`    |
-| `@xmachines/play-vue`    | `PlayRenderer`, `defineRegistry`    |
+| Package                                                             | Role                                |
+| ------------------------------------------------------------------- | ----------------------------------- |
+| [`@xmachines/play-dom`](../api/@xmachines/play-dom/README.md)       | `connectRenderer`, `defineRegistry` |
+| [`@xmachines/play-react`](../api/@xmachines/play-react/README.md)   | `PlayRenderer`, `defineRegistry`    |
+| [`@xmachines/play-solid`](../api/@xmachines/play-solid/README.md)   | `PlayRenderer`, `defineRegistry`    |
+| [`@xmachines/play-svelte`](../api/@xmachines/play-svelte/README.md) | `PlayRenderer`, `defineRegistry`    |
+| [`@xmachines/play-vue`](../api/@xmachines/play-vue/README.md)       | `PlayRenderer`, `defineRegistry`    |
 
 ### Router Adapters
 
-| Package                                 | Router                  |
-| --------------------------------------- | ----------------------- |
-| `@xmachines/play-dom-router`            | Vanilla browser history |
-| `@xmachines/play-react-router`          | React Router v7         |
-| `@xmachines/play-tanstack-react-router` | TanStack Router (React) |
-| `@xmachines/play-solid-router`          | SolidJS Router          |
-| `@xmachines/play-tanstack-solid-router` | TanStack Router (Solid) |
-| `@xmachines/play-vue-router`            | Vue Router              |
-| `@xmachines/play-svelte-spa-router`     | svelte-spa-router       |
-| `@xmachines/play-sveltekit-router`      | SvelteKit               |
+| Package                                                                                           | Router                  |
+| ------------------------------------------------------------------------------------------------- | ----------------------- |
+| [`@xmachines/play-dom-router`](../api/@xmachines/play-dom-router/README.md)                       | Vanilla browser history |
+| [`@xmachines/play-react-router`](../api/@xmachines/play-react-router/README.md)                   | React Router v7         |
+| [`@xmachines/play-tanstack-react-router`](../api/@xmachines/play-tanstack-react-router/README.md) | TanStack Router (React) |
+| [`@xmachines/play-solid-router`](../api/@xmachines/play-solid-router/README.md)                   | SolidJS Router          |
+| [`@xmachines/play-tanstack-solid-router`](../api/@xmachines/play-tanstack-solid-router/README.md) | TanStack Router (Solid) |
+| [`@xmachines/play-vue-router`](../api/@xmachines/play-vue-router/README.md)                       | Vue Router              |
+| [`@xmachines/play-svelte-spa-router`](../api/@xmachines/play-svelte-spa-router/README.md)         | svelte-spa-router       |
+| [`@xmachines/play-sveltekit-router`](../api/@xmachines/play-sveltekit-router/README.md)           | SvelteKit               |
 
 ## Related Documentation
 
-- **[Getting Started Guide](../guides/getting-started.md)** — First steps with XMachines
-- **[Installation Guide](../guides/installation.md)** — Package installation and TypeScript setup
+- **[Getting Started](../guides/getting-started.md)** — Installation, first actor, routing, and view renderer setup
 - **[API Reference](../api/README.md)** — Generated API docs for all public packages
 - **[Play RFC](../rfc/play.md)** — Complete architectural specification

package/examples/form-validation.md

@@ -306,5 +306,5 @@ window.addEventListener("beforeunload", () => {
 
 - **[Basic State Machine](basic-state-machine.md)** — Foundational concepts without a view layer
 - **[Routing Patterns](routing-patterns.md)** — Parameter routes, relative routes, and `always` auth guards
-- **[play-dom README](../../packages/play-dom/README.md)** — Full `ComponentFn`, `ActionFn`, and spec directive reference
-- **[play-router README](../api/@xmachines/play-router/README.md)** — Route extraction and tree building
+- **[`PlaySpec`](../api/@xmachines/play-actor/interfaces/PlaySpec.md)** — Spec type governing `meta.view`, `$bindState`, `$state`, and `contextProps`
+- **[`@xmachines/play-router`](../api/@xmachines/play-router/README.md)** — Route extraction and tree building

package/guides/README.md

@@ -7,14 +7,14 @@ Entry points for the current XMachines Play architecture.
 ## Start Here
 
 - **[Installation](installation.md)** — Core packages, framework-specific additions, TypeScript config, ESM setup
-- **[Getting Started](getting-started.md)** — `setup().createMachine()` → `definePlayer()` → `actor.start()` → TC39 Signals
+- **[Getting Started](getting-started.md)** — `setup().createMachine()` → [`definePlayer()`](../api/@xmachines/play-xstate/functions/definePlayer.md) → `actor.start()` → TC39 Signals
 
 ## Concepts
 
 Background reading that explains the _why_ behind XMachines design decisions. Read these when you want to understand the architecture, not just use the API.
 
 - **[Understanding State Machines](state-machines.md)** — What finite state machines are, how `meta.route` and `meta.view` extend them, and why they replace boolean flags, scattered guards, and component-level routing logic
-- **[Understanding the Actor Model](actor-model.md)** — The actor/infrastructure split, what `AbstractActor` enforces, why the machine has zero framework imports, and how the reset invariant works
+- **[Understanding the Actor Model](actor-model.md)** — The actor/infrastructure split, what [`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md) enforces, why the machine has zero framework imports, and how the reset invariant works
 - **[Understanding TC39 Signals](signals.md)** — The three signal primitives (`Signal.State`, `Signal.Computed`, `Signal.subtle.Watcher`), why XMachines uses them instead of observables, and the five architectural invariants they enforce
 
 ## Examples
@@ -25,8 +25,8 @@ Background reading that explains the _why_ behind XMachines design decisions. Re
 
 Framework-specific adapter documentation:
 
-- **[@xmachines/play-router](../api/@xmachines/play-router/README.md)** — Route extraction, route maps, and `RouterBridgeBase`
-- **[@xmachines/play-tanstack-react-router](../api/@xmachines/play-tanstack-react-router/README.md)** — TanStack React adapter (`PlayRouterProvider`, `createRouteMapFromTree`)
+- **[@xmachines/play-router](../api/@xmachines/play-router/README.md)** — Route extraction, route maps, and [`RouterBridgeBase`](../api/@xmachines/play-router/classes/RouterBridgeBase.md)
+- **[@xmachines/play-tanstack-react-router](../api/@xmachines/play-tanstack-react-router/README.md)** — TanStack React adapter (`PlayRouterProvider`, [`createRouteMapFromTree`](../api/@xmachines/play-router/functions/createRouteMapFromTree.md))
 - **[@xmachines/play-react-router](../api/@xmachines/play-react-router/README.md)** — React Router v7 data-router adapter
 - **[@xmachines/play-tanstack-solid-router](../api/@xmachines/play-tanstack-solid-router/README.md)** — TanStack Solid adapter
 - **[@xmachines/play-solid-router](../api/@xmachines/play-solid-router/README.md)** — SolidJS Router adapter
@@ -39,12 +39,12 @@ Framework-specific adapter documentation:
 
 View layer documentation by framework:
 
-- **[@xmachines/play-xstate](../api/@xmachines/play-xstate/README.md)** — `definePlayer`, `formatPlayRouteTransitions`, `PlayerActor`
-- **[@xmachines/play-react](../api/@xmachines/play-react/README.md)** — React rendering from actor-driven view state (`PlayRenderer`, `defineRegistry`)
+- **[@xmachines/play-xstate](../api/@xmachines/play-xstate/README.md)** — [`definePlayer`](../api/@xmachines/play-xstate/functions/definePlayer.md), [`formatPlayRouteTransitions`](../api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md), [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md)
+- **[@xmachines/play-react](../api/@xmachines/play-react/README.md)** — React rendering from actor-driven view state (`PlayRenderer`, [`defineRegistry`](../api/@xmachines/play-dom/functions/defineRegistry.md))
 - **[@xmachines/play-vue](../api/@xmachines/play-vue/README.md)** — Vue rendering from actor-driven view state
 - **[@xmachines/play-solid](../api/@xmachines/play-solid/README.md)** — SolidJS rendering from actor-driven view state
 - **[@xmachines/play-svelte](../api/@xmachines/play-svelte/README.md)** — Svelte 5 rendering from actor-driven view state
-- **[@xmachines/play-dom](../api/@xmachines/play-dom/README.md)** — Vanilla DOM rendering (`connectRenderer`, `defineRegistry`)
+- **[@xmachines/play-dom](../api/@xmachines/play-dom/README.md)** — Vanilla DOM rendering ([`connectRenderer`](../api/@xmachines/play-dom/functions/connectRenderer.md), [`defineRegistry`](../api/@xmachines/play-dom/functions/defineRegistry.md))
 
 ## API Reference
 

package/guides/actor-model.md

@@ -33,20 +33,20 @@ Infrastructure → actor: only via actor.send({ type: "..." })
 
 ## What the actor owns
 
-An actor in XMachines is a `PlayerActor` — a concrete class that extends XState's `Actor` class via `AbstractActor`. It implements three reactive properties:
+An actor in XMachines is a [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md) — a concrete class that extends XState's `Actor` class via [`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md). It implements three reactive properties:
 
-| Property             | Type                              | What it is                                                              |
-| -------------------- | --------------------------------- | ----------------------------------------------------------------------- |
-| `actor.state`        | `Signal.State<Snapshot>`          | Updated on every XState transition. The full machine snapshot.          |
-| `actor.currentRoute` | `Signal.Computed<string \| null>` | Derived from the active state node's `meta.route`.                      |
-| `actor.currentView`  | `Signal.State<PlaySpec \| null>`  | Updated on each transition. Holds the `PlaySpec` that drives renderers. |
+| Property             | Type                              | What it is                                                                                                                     |
+| -------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `actor.state`        | `Signal.State<Snapshot>`          | Updated on every XState transition. The full machine snapshot.                                                                 |
+| `actor.currentRoute` | `Signal.Computed<string \| null>` | Derived from the active state node's `meta.route`.                                                                             |
+| `actor.currentView`  | `Signal.State<PlaySpec \| null>`  | Updated on each transition. Holds the [`PlaySpec`](../api/@xmachines/play-actor/interfaces/PlaySpec.md) that drives renderers. |
 
 All three are set by the actor, never by infrastructure. Infrastructure reads them via signals.
 
 The actor also owns:
 
 - **Guards** — it decides whether a transition is valid. If a router sends a `play.route` event for a path the actor's guards reject, the actor does not transition. It then emits its current valid route back through `currentRoute`, and the router bridge overwrites the URL to match.
-- **Error states** — structured errors (`PlayError`) are part of the actor's state graph, not thrown into the environment.
+- **Error states** — structured errors ([`PlayError`](../api/@xmachines/play/classes/PlayError.md)) are part of the actor's state graph, not thrown into the environment.
 - **Initial route** — `actor.initialRoute` is the route the actor starts in. Router adapters use this for initial navigation, not the browser's current URL.
 
 ---
@@ -87,17 +87,17 @@ This is why the invariant is called **State-Driven Reset** in the Play RFC.
 
 ---
 
-## `AbstractActor` — the enforced contract
+## [`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md) — the enforced contract
 
-`AbstractActor` (from `@xmachines/play-actor`) is the abstract base class that all actor implementations must extend. It extends XState's `Actor`, which means:
+[`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md) (from [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md)) is the abstract base class that all actor implementations must extend. It extends XState's `Actor`, which means:
 
 - XState's inspection API works (`@xstate/inspect`)
 - XState DevTools attach to actors normally
 - The full XState ecosystem (testing utilities, visualization) is compatible
 
-`AbstractActor` adds one abstract requirement: a reactive `state` property of type `Signal.State<unknown>`. This is the single point where XState's pull-based snapshot API is bridged to TC39's push-based signal system.
+[`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md) adds one abstract requirement: a reactive `state` property of type `Signal.State<unknown>`. This is the single point where XState's pull-based snapshot API is bridged to TC39's push-based signal system.
 
-The two optional capability interfaces — `Routable` and `Viewable` — are deliberately separate:
+The two optional capability interfaces — [`Routable`](../api/@xmachines/play-actor/interfaces/Routable.md) and [`Viewable`](../api/@xmachines/play-actor/interfaces/Viewable.md) — are deliberately separate:
 
 - Not every actor needs routing (e.g., a background data-sync actor).
 - Not every actor drives a view (e.g., a sub-actor composed inside a parent).
@@ -118,13 +118,13 @@ class PlayerActor extends AbstractActor<SomeMachine> implements Routable, Viewab
 }
 ```
 
-In practice you never write `PlayerActor` yourself — `definePlayer` from `@xmachines/play-xstate` creates one from your machine definition.
+In practice you never write [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md) yourself — [`definePlayer`](../api/@xmachines/play-xstate/functions/definePlayer.md) from [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) creates one from your machine definition.
 
 ---
 
-## `definePlayer` — the factory builder
+## [`definePlayer`](../api/@xmachines/play-xstate/functions/definePlayer.md) — the factory builder
 
-`definePlayer({ machine })` is the primary entry point for creating actors:
+[`definePlayer({ machine })`](../api/@xmachines/play-xstate/functions/definePlayer.md) is the primary entry point for creating actors:
 
 ```typescript
 import { definePlayer } from "@xmachines/play-xstate";
@@ -137,7 +137,7 @@ const actor = createPlayer();
 actor.start();
 ```
 
-`definePlayer` returns a **factory function**, not an actor. This is intentional: it lets you create multiple independent instances (e.g., one per test, one per user session) without re-processing the machine definition each time.
+[`definePlayer`](../api/@xmachines/play-xstate/functions/definePlayer.md) returns a **factory function**, not an actor. This is intentional: it lets you create multiple independent instances (e.g., one per test, one per user session) without re-processing the machine definition each time.
 
 The factory accepts optional `input` (initial context overrides) and a `restore` snapshot (for resumable sessions):
 
@@ -152,7 +152,7 @@ const actor = createPlayer(undefined, { snapshot }); // restored from snapshot
 
 The machine definition — the `setup().createMachine(...)` call — is pure TypeScript with zero runtime dependencies on browsers, routers, or UI frameworks. This is not a convention; it is enforced by the dependency graph.
 
-`@xmachines/play-xstate` depends on `xstate` and `@xmachines/play-signals`. It does not depend on React, Vue, any router library, or any browser API. Your machine file inherits those same boundaries.
+[`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) depends on `xstate` and [`@xmachines/play-signals`](../api/@xmachines/play-signals/README.md). It does not depend on React, Vue, any router library, or any browser API. Your machine file inherits those same boundaries.
 
 This has concrete practical benefits:
 
@@ -175,6 +175,6 @@ The Play RFC captures the actor/infrastructure split in a single statement:
 - [Understanding TC39 Signals](signals.md) — how the actor communicates with infrastructure
 - [Understanding State Machines](state-machines.md) — how the machine definition drives actor behavior
 - [Getting Started](getting-started.md) — hands-on walkthrough creating and starting an actor
-- [@xmachines/play-actor README](../api/@xmachines/play-actor/README.md) — API reference for `AbstractActor`
-- [@xmachines/play-xstate README](../api/@xmachines/play-xstate/README.md) — API reference for `definePlayer` and `PlayerActor`
+- [@xmachines/play-actor README](../api/@xmachines/play-actor/README.md) — API reference for [`AbstractActor`](../api/@xmachines/play-actor/classes/AbstractActor.md)
+- [@xmachines/play-xstate README](../api/@xmachines/play-xstate/README.md) — API reference for [`definePlayer`](../api/@xmachines/play-xstate/functions/definePlayer.md) and [`PlayerActor`](../api/@xmachines/play-xstate/classes/PlayerActor.md)
 - [Play RFC](../rfc/play.md) — complete architectural specification