# Voxcode Documentation

Welcome to the Voxcode documentation hub. This guide helps you go from first install to production-grade workflows.

## Start Here

| Document | Purpose |
| --- | --- |
| [Quickstart](quickstart.md) | Install Voxcode and run your first real session |
| [Usage](usage.md) | Daily workflow patterns and command usage |
| [Providers](providers.md) | Provider setup, env vars, and model examples |
| [Settings](settings.md) | Runtime configuration and environment flags |

## Core Workflows

| Document | Purpose |
| --- | --- |
| [Sessions](sessions.md) | Resume, branch, and compact session history |
| [Compaction](compaction.md) | Reduce session history while preserving context |
| [Extensions](extensions.md) | Add custom tools, commands, and hooks |
| [Skills](skills.md) | Reusable prompt workflow packages |
| [Models](models.md) | Model selection strategies and configuration |
| [Prompt Templates](prompt-templates.md) | Reusable prompt patterns and variables |
| [Keybindings](keybindings.md) | Keyboard shortcuts for interactive mode |

## Interfaces

| Document | Purpose |
| --- | --- |
| [TUI](tui.md) | Terminal UI reference and customization |
| [SDK](sdk.md) | Programmatic integration with TypeScript/Node |
| [RPC](rpc.md) | Process-level integration via RPC mode |
| [JSON](json.md) | Structured JSON output for scripting and CI |

## Platform Notes

| Document | Purpose |
| --- | --- |
| [Windows](windows.md) | Windows-specific runtime notes |
| [Termux](termux.md) | Android/Termux setup notes |
| [tmux](tmux.md) | Multiplexer best practices |
| [Terminal Setup](terminal-setup.md) | Terminal compatibility and UX tips |
| [Shell Aliases](shell-aliases.md) | Shortcut aliases for daily commands |

## Advanced

| Document | Purpose |
| --- | --- |
| [Development](development.md) | Local setup, testing, and contribution workflow |
| [Custom Providers](custom-provider.md) | Write your own provider integration |
| [Themes](themes.md) | Terminal UI theme customization |
| [Session Format](session-format.md) | On-disk session storage format |
| [Packages](packages.md) | Monorepo package reference |

> [!TIP]
> If you are new to Voxcode, read in this order: `quickstart` -> `usage` -> `providers` -> `sessions`.
