# Documentation

Start here:

- **[Getting started](./getting-started.md)** — installation, first effects, and running examples
- **[Architecture](./ARCHITECTURE.md)** — how the runtime is structured
- **[Cancellation & interruption](./cancellation.md)** — interruption semantics, scopes, and cancellable `Async`
- **[Observability](./observability.md)** — hooks, events, sinks, tracing, and HTTP policy context
- **[Framework integrations](./framework-integrations.md)** — Vanilla, React, Next.js, Angular, Express, Fastify, and Nest patterns
- **[Runnable examples](https://github.com/BaldrVivaldelli/brass-runtime/tree/main/examples)** — Vanilla, Express, NestJS, Next.js, React, Angular, and shared helper apps
- **[NestJS integration](./frameworks/nestjs.md)** — Brass module, Grafana/OTLP observability, HTTP client DI, and inbound spans
- **[Article: HTTP and observability in Brass](./articles/brass-runtime-http-observability.md)** — narrative summary of the HTTP, policy, transport, and observability work
- **[HTTP client](./http.md)** — ZIO-style HTTP built on brass-runtime
- **[HTTP recipes](./http-recipes.md)** — typed clients, custom transports, production adoption, observability, and config validation
- **[Recipes](./recipes/README.md)** — copyable runtime, layer, HTTP server, testing, and performance paths
- **[API polish notes](./api-polish.md)** — first-release DX audit and compatibility posture
- **[First release checklist](./release.md)** — local release gate and perf evidence workflow
- **[Modules overview](./modules.md)** — map of core modules and where things live
- **[AI context pack](./ai/PROJECT_MAP.md)** — compact project map, invariants, validation matrix, and public API notes
- **[Agent module boundaries](./agent-boundaries.md)** — rules for keeping `brass-agent` isolated from the core runtime
- **[Brass Agent install and configure](./agent-install-and-configure.md)** — end-to-end local setup for CLI, config, providers, and VS Code

- [Agent LLM adapters](./agent-llm-adapters.md)
- [Agent env files](./agent-env-files.md)
- [Agent global usage and workspace discovery](./agent-global-usage.md)
- [Agent apply mode](./agent-apply-mode.md)
- [Brass Agent CLI](./agent-cli.md)
- [Agent init](./agent-init.md)
- [Agent observability](./agent-observability.md)
- [Agent approvals](./agent-approvals.md)
- [Agent config and policy files](./agent-config.md)
- [Agent project command discovery](./agent-project-commands.md)
- [Agent project intelligence](./agent-project-intelligence.md)
- [Declarative optimized planning roadmap](./agent-declarative-optimized-planning.md)
- [Agent context discovery](./agent-context-discovery.md)
- [Agent patch quality loop](./agent-patch-quality-loop.md)
- [Agent automatic rollback safety](./agent-rollback-safety.md)
- [Agent DX surfaces](./agent-dx.md)

- [VS Code patch preview](./agent-vscode-patch-preview.md)
- [VS Code enhanced diff preview](./agent-vscode-diff-preview.md)
- [VS Code run history](./agent-vscode-run-history.md)
- [VS Code batch runner](./agent-vscode-batch-runner.md)
- [VS Code UX](./agent-vscode-ux.md)
- [VS Code Project dashboard](./agent-vscode-project-dashboard.md)
- [VS Code Chat layout / focus mode](./agent-vscode-chat-layout.md)
- [Copilot-like VS Code DX](./agent-copilot-like-dx.md)
- [Chat sessions and slash commands](./agent-chat-sessions.md)
- [Agent follow-up context](./agent-follow-up-context.md)
- [VS Code code actions](./agent-vscode-code-actions.md)
- [VS Code problems-aware chat](./agent-vscode-problems.md)
- [VS Code inline assist](./agent-vscode-inline-assist.md)
- [Agent release readiness](./agent-release-readiness.md)
- [VS Code local install](./agent-vscode-install.md)
- [VS Code auto-discovery](./agent-vscode-auto-discovery.md)
- [VS Code model setup](./agent-vscode-model-setup.md)
- [Agent local install and doctor](./agent-local-install.md)
- [Agent local tests](./agent-local-tests.md)

- [Agent rollback patches](./agent-rollback.md)
- [Agent redaction](./agent-redaction.md)
- [Agent run artifacts](./agent-run-artifacts.md)
- [Agent CI mode](./agent-ci.md)
- [Agent presets](./agent-presets.md)
- [Agent batch runs](./agent-batch.md)
- [VS Code full clean and reinstall](./agent-vscode-clean-install.md)
- [Agent language and workspace setup UX](agent-language-workspace-ux.md)