38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# 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
|