@@ -57,162 +57,6 @@ For agent-facing docs, MCP, CLI, and diagnostic handles, see
5757
5858Not using Laravel? See the [standalone server](/docs/2.0/polyglot/server), [CLI](/docs/2.0/polyglot/cli), or [Python SDK](/docs/2.0/polyglot/python).
5959
60- <!-- Source: docs/search-and-navigation.md -->
61-
62- # Search and Navigation
63-
64- Use this page when a search term is close to the problem, but not the exact
65- page title. Durable Workflow v2 docs are organized by task; this page maps
66- common phrases to the smallest useful guide.
67-
68- ## Common Searches
69-
70- | Search phrase | Start here | Then use |
71- | --- | --- | --- |
72- | `quickstart`, `install`, `first workflow` | [Getting Started](./getting-started.md) | [Sample App](./sample-app.md) |
73- | `PHP`, `workflow authoring`, `API reference` | [Workflow Authoring API Reference](./defining-workflows/workflow-authoring-reference.md) | [Workflows](./defining-workflows/workflows.md), [Message Streams](./features/message-streams.md) |
74- | `workflow stuck`, `failed activity`, `retry exhausted` | [Failures and Recovery](./failures-and-recovery.md) | [Monitoring](./monitoring.md) |
75- | `Waterline`, `workflow dashboard`, `history export` | [Monitoring](./monitoring.md) | [AI-Assisted Development](./ai-assisted-development.md) |
76- | `actionability`, `diagnostic_only`, `repair_state` | [Monitoring](./monitoring.md) | [Failures and Recovery](./failures-and-recovery.md) |
77- | `CLI`, `dw command`, `json output` | [CLI](./polyglot/cli.mdx) | [CLI Command Reference](./polyglot/cli-reference.md), [CLI five-minute operator quickstart](./polyglot/cli.mdx#five-minute-operator-quickstart) |
78- | `Python`, `SDK`, `polyglot` | [Python SDK](./polyglot/python.md) | [CLI and Python Parity](./polyglot/cli-python-parity.md) |
79- | `server mode`, `HTTP API`, `control plane` | [Server](./polyglot/server.md) | [Embedded to Server Migration](./polyglot/embedded-to-server.md) |
80- | `namespace`, `auth`, `worker registration` | [Namespace, Auth, And Worker Registration](./polyglot/namespace-auth-workers.md) | [Server API Reference](./polyglot/server-api-reference.md), [Worker Protocol](./polyglot/worker-protocol.md) |
81- | `worker protocol`, `external worker`, `heartbeats` | [Worker Protocol](./polyglot/worker-protocol.md) | [External Execution Surface](./polyglot/external-execution.md) |
82- | `task queue`, `rate limit`, `admission` | [Task Queue Admission](./polyglot/task-queue-admission.md) | [Monitoring](./monitoring.md) |
83- | `MCP`, `AI client`, `llms.txt` | [MCP Workflow Surface](./mcp-workflows.md) | [AI-Assisted Development](./ai-assisted-development.md), [Sample App](./sample-app.md) |
84- | `agent loop`, `AI debugging`, `structured diagnosis` | [Agent Operating Loop](./agent-operating-loop.md) | [AI-Assisted Development](./ai-assisted-development.md) |
85- | `agent tooling`, `machine-readable operations`, `MCP diagnostics` | [Agent Tooling Contract](./agent-tooling-contract.md) | [Agent Operating Loop](./agent-operating-loop.md), [CLI and Python Parity](./polyglot/cli-python-parity.md) |
86- | `signals`, `updates`, `queries` | [Signals](./features/signals.md) | [Updates](./features/updates.md), [Queries](./features/queries.md) |
87- | `timers`, `wait`, `sleep`, `condition` | [Timers](./features/timers.md) | [Condition Waits](./features/condition-waits.md), [Timeouts](./features/timeouts.md) |
88- | `history size`, `continue as new`, `compaction` | [Continue As New](./features/continue-as-new.md) | [Support Boundaries](./support.md) |
89-
90- ## Zero-Result Watchlist
91-
92- Track adjacent terms that users may type before the docs have a matching page
93- title. Each phrase below is pinned in the build-time discoverability contract so
94- future edits cannot silently drop the route.
95-
96- | Search phrase | Start here | Then use | Source | Last reviewed | Action |
97- | --- | --- | --- | --- | --- | --- |
98- | `cron`, `schedule`, `recurring jobs` | [Schedules](./features/schedules.md) | [Timers](./features/timers.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until schedule docs rank for cron and recurring jobs. |
99- | `worker logs`, `trace id`, `metrics` | [Monitoring](./monitoring.md) | [AI-Assisted Development](./ai-assisted-development.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until monitoring docs rank for logs, traces, and metrics. |
100- | `payload codec`, `PHP serialization` | [Passing Data](./defining-workflows/passing-data.md) | [Server](./polyglot/server.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until payload and codec searches land on passing-data guidance. |
101- | `upgrade embedded app`, `server cutover` | [Embedded to Server Migration](./polyglot/embedded-to-server.md) | [Server](./polyglot/server.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until migration and cutover searches land on the embedded-to-server guide. |
102- | `Helm`, `high availability`, `rolling upgrade` | [Self-Hosting Deployments](./deployment.md) | [Support Boundaries](./support.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until unsupported topology searches land on the deployment support matrix. |
103- | `webhook bridge`, `external handler`, `bridge adapter` | [External Execution Surface](./polyglot/external-execution.md) | [Webhooks](./features/webhooks.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until bridge and handler searches land on the external execution contract. |
104- | `dispatch budget group`, `downstream quota`, `rate limit` | [Task Queue Admission](./polyglot/task-queue-admission.md) | [Monitoring](./monitoring.md) | docs Phase 3 zero-result watchlist | 2026-04-22 | Keep mapped until downstream quota searches land on task queue admission. |
105-
106- ## Task Indexes
107-
108- - [Topics](./topics.md) groups docs by authoring, operations, control-plane,
109- external execution, reliability, and AI automation work.
110- - [CLI Command Reference](./polyglot/cli-reference.md) is the command lookup
111- page for scripts, CI, and agents.
112- - [Namespace, Auth, And Worker Registration](./polyglot/namespace-auth-workers.md)
113- is the request-authority reference for server namespaces, role-scoped
114- credentials, and worker registration.
115- - [AI-Assisted Development](./ai-assisted-development.md) lists the v2 LLM
116- manifests, MCP tools, CLI contracts, Waterline facts, and SDK surfaces that
117- automation should use instead of guessing from screenshots.
118- - [Agent Operating Loop](./agent-operating-loop.md) gives AI clients the
119- concrete order for discovering workflows, making changes, running structured
120- commands, diagnosing failures, and reporting facts.
121- - [Agent Tooling Contract](./agent-tooling-contract.md) defines the
122- machine-operable contract shared by MCP tools, CLI JSON, server diagnostics,
123- Waterline exports, and SDK parity fixtures.
124- - [MCP Workflow Surface](./mcp-workflows.md) defines the sample-app MCP
125- endpoint, workflow tool contract, no-credential smoke keys, and report shape.
126- - Topic tags expose cross-page trails for [migration](/docs/2.0/tags/migration),
127- [observability](/docs/2.0/tags/observability), [timers](/docs/2.0/tags/timers),
128- [operations](/docs/2.0/tags/operations), [task queues](/docs/2.0/tags/task-queues),
129- and [message streams](/docs/2.0/tags/message-streams).
130-
131- ## Search Feedback
132-
133- When a common query fails to land on the right page, add it to the
134- discoverability contract in `scripts/discoverability-contract.json` with the
135- expected target page. The build checks that each tracked query points to a real
136- v2 doc and that the target document contains the search language or its listed
137- aliases.
138-
139- Zero-result watchlist entries also carry a source, review date, and action.
140- That keeps ambiguous searches such as Helm, bridge adapters, and downstream
141- quota tied to an owner decision instead of becoming stale prose on this page.
142-
143- <!-- Source: docs/topics.md -->
144-
145- # Topics
146-
147- Use this page when you know the task or operator concern, but not the package or
148- page name. Durable Workflow v2 has several product surfaces: the Laravel
149- workflow engine, the standalone server, the CLI, the Python SDK, Waterline, and
150- the sample app. The links below group those surfaces by job.
151-
152- ## Start Or Author Workflows
153-
154- - [Getting Started](./getting-started.md) - install v2 and run the first workflow.
155- - [Workflows](./defining-workflows/workflows.md) - define a workflow class.
156- - [Activities](./defining-workflows/activities.md) - move non-deterministic work out of replay.
157- - [Starting Workflows](./defining-workflows/starting-workflows.md) - start runs through the Laravel API.
158- - [Workflow Authoring API Reference](./defining-workflows/workflow-authoring-reference.md) - look up exact v2 PHP facade signatures, message-stream methods, and replay rules.
159- - [Message Streams](./features/message-streams.md) - receive repeated messages through `inbox()` and publish ordered replies through `outbox()`.
160-
161- ## Run And Operate
162-
163- - [Search and Navigation](./search-and-navigation.md) - map common query phrases to the smallest useful guide.
164- - [Self-Hosting Deployments](./deployment.md) - deploy the runtime and its dependencies.
165- - [Monitoring](./monitoring.md) - choose between Waterline durable state and runtime telemetry.
166- - [Version Compatibility](./compatibility.md) - understand which protocol manifests and component versions are compatible.
167- - [Failures and Recovery](./failures-and-recovery.md) - recover failed, stuck, or interrupted work.
168- - [Support Boundaries](./support.md) - know which behaviors are product contracts.
169-
170- ## Control Plane And Polyglot
171-
172- - [Server](./polyglot/server.md) - use the standalone HTTP control plane.
173- - [Server API Reference](./polyglot/server-api-reference.md) - call exact HTTP control-plane and worker-plane routes.
174- - [Namespace, Auth, And Worker Registration](./polyglot/namespace-auth-workers.md) - align namespace headers, role-scoped credentials, and worker registration.
175- - [Embedded to Server Migration](./polyglot/embedded-to-server.md) - move from Laravel-embedded execution to server mode.
176- - [CLI](./polyglot/cli.mdx) - install and configure `dw`.
177- - [CLI Command Reference](./polyglot/cli-reference.md) - script exact command shapes and output modes.
178- - [Python SDK](./polyglot/python.md) - start, observe, signal, and run workers from Python.
179- - [CLI and Python Parity](./polyglot/cli-python-parity.md) - compare the same control-plane operations across clients.
180-
181- ## External Execution And Ingress
182-
183- - [External Execution Surface](./polyglot/external-execution.md) - use bounded external workers, bridge adapters, and AI-operable handlers.
184- - [Worker Protocol](./polyglot/worker-protocol.md) - implement polling, leasing, heartbeats, and task results.
185- - [Task Queue Admission](./polyglot/task-queue-admission.md) - keep worker queues bounded and observable.
186- - [Webhooks](./features/webhooks.md) - receive HTTP ingress and control-plane commands.
187- - [Sample App](./sample-app.md) - see a Laravel consumer app wired to current v2 patterns.
188-
189- ## Reliability Patterns
190-
191- - [Signals](./features/signals.md), [Updates](./features/updates.md), and [Queries](./features/queries.md) - choose the right command type.
192- - [Timers](./features/timers.md), [Condition Waits](./features/condition-waits.md), and [Timeouts](./features/timeouts.md) - wait without holding a process.
193- - [Continue As New](./features/continue-as-new.md) - keep history bounded while preserving run handoff semantics.
194- - [Sagas](./features/sagas.md) - compensate partially completed work.
195- - [Cancel and Terminate](./features/cancel-and-terminate.md) - stop workflows intentionally and inspect the outcome.
196-
197- ## AI And Automation
198-
199- - [AI-Assisted Development](./ai-assisted-development.md) - use stable contracts for code generation and agents.
200- - [Agent Operating Loop](./agent-operating-loop.md) - give agents a repeatable discover, change, run, diagnose, and report loop.
201- - [MCP Workflow Surface](./mcp-workflows.md) - expose sample-app workflows to AI clients through structured tools.
202- - [Agent Tooling Contract](./agent-tooling-contract.md) - align MCP tools, CLI JSON, server diagnostics, Waterline exports, and SDK fixtures.
203- - [CLI](./polyglot/cli.mdx) - install a pinned `dw`, save an environment profile, and run the five-minute operator quickstart.
204- - [External Execution Surface](./polyglot/external-execution.md) - expose machine-readable task and result envelopes.
205- - [CLI and Python Parity](./polyglot/cli-python-parity.md) - share request fixtures across automation surfaces.
206-
207- ## Topic Tags
208-
209- - [Migration](/docs/2.0/tags/migration) - upgrade and rollout pages for v2 adoption.
210- - [Observability](/docs/2.0/tags/observability) - Waterline, telemetry, and operator evidence.
211- - [Timers](/docs/2.0/tags/timers) - durable waits, deterministic time, and schedules.
212- - [Operations](/docs/2.0/tags/operations) - production diagnostics, recovery, and support boundaries.
213- - [Task Queues](/docs/2.0/tags/task-queues) - worker admission, dispatch budgets, and queue health.
214- - [Message Streams](/docs/2.0/tags/message-streams) - inbox/outbox authoring and repeated messages.
215-
21660<!-- Source: docs/installation.md -->
21761
21862# Installation
0 commit comments