# Nerve Docs

Start here when you need setup, operations, or contributor guidance.

## Top-level entry points

- [Project README](../README.md), product overview and quick start
- [Contributing](../CONTRIBUTING.md), local development, tests, and PR expectations
- [Changelog](../CHANGELOG.md), release notes

## Core docs

- [Architecture](./ARCHITECTURE.md), codebase structure and system design
- [Configuration](./CONFIGURATION.md), `.env`, auth, access modes, TTS providers, and UI settings
- [API](./API.md), backend endpoints and behavior
- [Security](./SECURITY.md), threat model and hardening notes
- [Troubleshooting](./TROUBLESHOOTING.md), common failures and fixes
- [Updating](./UPDATING.md), built-in updater flow and rollback
- [Installer Steps](./INSTALLER-STEPS.md), what the installer does
- [Agent Markers](./AGENT-MARKERS.md), TTS, charts, and kanban markers
- [Code Review](./CODE_REVIEW.md), review guidance for the current codebase

## Setup and deployment

- [AI Agent Setup](./AI_SETUP.md)
- [Nerve Agent Install Contract](./INSTALL.md)
- [Run everything on one machine](./DEPLOYMENT-A.md)
- [Use a cloud Gateway with Nerve on your laptop](./DEPLOYMENT-B.md)
- [Run both Nerve and Gateway in the cloud](./DEPLOYMENT-C.md)
- [Add Tailscale to an existing Nerve install](./TAILSCALE.md)