# Vocal Documentation

## For Users

| Doc | Contents |
|-----|----------|
| [Getting Started](user/getting-started.md) | Install, first transcription, first TTS |
| [Models](user/models.md) | Model catalog, download, hardware guide |
| [CLI Reference](user/cli.md) | All CLI commands with options |
| [Configuration](user/configuration.md) | Environment variables, `.env` file |

## For Developers & Maintainers

| Doc | Contents |
|-----|----------|
| [Contributing](developer/contributing.md) | Setup, workflow, PR checklist |
| [Architecture](developer/architecture.md) | Package structure, adapter pattern, OpenAI compatibility |
| [Adding Models](developer/adding-models.md) | Add backends (STT/TTS), add catalog entries |
| [Testing](developer/testing.md) | Test tiers, CI, cross-platform testing |
| [Release Process](developer/release.md) | Version bump, PyPI publish, rollback |
| [Manual Testing](manual-testing.md) | Domain-by-domain human QA guide |

## Quick Links

- [GitHub Repository](https://github.com/niradler/vocal)
- [Interactive API Docs](http://localhost:8000/docs) (when server is running)
- [PyPI — vocal-ai](https://pypi.org/project/vocal-ai/)
- [License (SSPL-1.0)](../LICENSE)
- [AGENTS.md](../AGENTS.md) — Maintainer + AI agent reference
