Documentation
The full documentation lives in docs/:
| Page | What it covers |
|---|---|
| Getting Started | Installation, the inline form, the Outcome, a first class-form point, the trace middleware. |
| Control Points | Naming, domains, the builder, the class form, nesting, Laravel Context. |
| Risks and Corrections | recover() semantics, the catch-all, escalate(), the risks Monitor raises. |
| Policies and Limits | Retry, Transaction, Breaker, pipeline order, the three limits, profiles. |
| Records | The record schema, levels, redaction, NDJSON, Monitor::log(), events. |
| Tracing | Trace ids, the middleware, Http::traced(), jobs, console. |
| Jobs | Dispatching a point as a job, Horizon tags, WaitForBreaker, what a job inherits. |
| Breakers | The state machine, the standalone API, the route middleware. |
| Store | Enabling the outcome store, what is written and when, monitor:outcomes, pruning. |
| Inventory | monitor:points, every rule, --check in CI, monitor:explain, make:control-point. |
| Testing | Monitor::fake() and its assertions, the Pest expectations, the PHPStan rule, and the package's own tests. |
| Agents | The Boost guideline and skill, the MCP server, its tools, resources and prompt. |
| Configuration | Every key in config/monitor.php with its type, default and environment variable. |
| Extending | Custom policies, escalations, inventory rules, event listeners. |
| Upgrading | Every 0.1 surface and its 1.0 replacement. |