# Documentation

This folder contains project documentation for Overland Controller.

## Primary Documents

- `API.md` - HTTP API reference
- `SERIAL_COMMANDS.md` - Serial console command reference
- `HARDWARE.md` - Hardware overview
- `ARCHITECTURE.md` - System architecture
- `CHANGELOG.md` - Project change history

## Project Tracking

- `CHATGPT_HANDOFF.md` - Concise assistant handoff with current status, goals, constraints, and validation notes
- `project-state.md` - Current project state
- `roadmap.md` - Roadmap and future plans
- `decisions.md` - Architecture and implementation decisions

## Technical References

- `dashboard-esp32s3.md` - Current Waveshare ESP32-S3 dashboard plan
- `CONFIGURATION.md` - Configuration model and setup concepts
- `TEMP_SETUP.md` - DS18B20 temperature sensor setup
- `UART_PROTOCOL.md` - Optional UART diagnostics protocol

## Archive

Older or duplicate documents have been moved to `archive/`.

Archived documents are kept for history, but the primary documents above should be treated as the current source of truth.

## Parity

- `PARITY_MATRIX.md` - Command parity across USB serial, UART JSON, and HTTP API

- `controller-roles.md` - Cargo ESP vs Dashboard ESP32-S3 responsibility boundaries

- `../archive/legacy-pico-dashboard/` - Archived Pico dashboard implementation kept for reference only.
- `../firmware/esp32-s3-dashboard/` - Current ESP32-S3 dashboard firmware placeholder.

- `repo-cleanup-audit.md` - Active repo audit for stale Pico/UART dashboard references and DS18B20 documentation status.
- `API.md` - High-level API notes and telemetry ownership.

- `cargo-api-contract.md` - Cargo ESP API ownership and expected API areas for WebUI/dashboard clients.

- `pre-lilygo-baseline-checklist.md` - Checklist for creating a known-good Cargo ESP 2-channel baseline before future LilyGO migration.

## LilyGO Transition

The LILYGO T-Relay-S3 6-way board has been ordered as a future Cargo ESP candidate.

Current development remains on the 2-channel relay board while the API and docs are prepared for output-count-agnostic operation.