# Documentation

Maintained documentation for Ferret.

## User & Operator Docs

- [`architecture.md`](./architecture.md) — System overview, components, and data flow
- [`deployment.md`](./deployment.md) — Installation, Docker, and CI usage
- [`THREAT_MODEL.md`](./THREAT_MODEL.md) — Adversaries, mitigations, and residual risks
- [`lsp.md`](./lsp.md) — Language Server (LSP) setup and editor integration
- [`migration-v2.5-to-v2.6.md`](./migration-v2.5-to-v2.6.md) — Upgrade guide from v2.5 to v2.6

## Reference & Analysis

- [`REPOSITORY_ANALYSIS.md`](./REPOSITORY_ANALYSIS.md) — Architecture, landscape positioning, security scan, and documentation review
- [`mcp-scan-comparison.md`](./mcp-scan-comparison.md) — Architectural comparison with Snyk's mcp-scan

## Generated

- `api/` — TypeDoc API reference (gitignored; run `npm run docs:api` to generate)