From f609f2ea43f9bc7e373286580d98802334804be8 Mon Sep 17 00:00:00 2001 From: nick Date: Sun, 7 Jun 2026 09:52:24 -0600 Subject: [PATCH] Archive stale documentation --- HARDWARE.md | 10 ---------- README.md | 3 ++- docs/README.md | 7 +++---- docs/archive/legacy-current-cleanup/README.md | 13 +++++++++++++ .../legacy-current-cleanup/handoff.md} | 0 .../legacy-current-cleanup}/hardware-status.md | 0 .../legacy-current-cleanup/legacy-uart-protocol.md} | 0 .../legacy-current-cleanup/temp-api.md} | 0 docs/{ => archive/legacy-current-cleanup}/wiring.md | 0 hardware/archive/README.md | 5 +++++ .../cat5-pinout-legacy.md} | 0 .../esp32-pinout-legacy.md} | 0 .../pico-pinout-legacy.md} | 0 .../uart-cat5-pinout-legacy.md} | 0 hardware/pinout.md | 0 15 files changed, 23 insertions(+), 15 deletions(-) delete mode 100644 HARDWARE.md create mode 100644 docs/archive/legacy-current-cleanup/README.md rename docs/{HANDOFF.md => archive/legacy-current-cleanup/handoff.md} (100%) rename docs/{ => archive/legacy-current-cleanup}/hardware-status.md (100%) rename docs/{protocol.md => archive/legacy-current-cleanup/legacy-uart-protocol.md} (100%) rename docs/{TEMP_API.md => archive/legacy-current-cleanup/temp-api.md} (100%) rename docs/{ => archive/legacy-current-cleanup}/wiring.md (100%) create mode 100644 hardware/archive/README.md rename hardware/{cat5-pinout.md => archive/cat5-pinout-legacy.md} (100%) rename hardware/{esp32-pinout.md => archive/esp32-pinout-legacy.md} (100%) rename hardware/{pico-pinout.md => archive/pico-pinout-legacy.md} (100%) rename hardware/{uart-cat5-pinout.md => archive/uart-cat5-pinout-legacy.md} (100%) delete mode 100644 hardware/pinout.md diff --git a/HARDWARE.md b/HARDWARE.md deleted file mode 100644 index 7781a40..0000000 --- a/HARDWARE.md +++ /dev/null @@ -1,10 +0,0 @@ - ---- - -# Hardware Notes - -The current hardware source of truth is `docs/HARDWARE.md`. - -The Cargo ESP32 relay board outputs are control/trigger outputs only. Do not route fridge, Starlink, inverter, lights, or other major load current through the ESP32 relay board. - -Use properly fused automotive relays or contactors for major loads. diff --git a/README.md b/README.md index b24bae0..b288e80 100644 --- a/README.md +++ b/README.md @@ -82,10 +82,11 @@ Important docs: - `docs/API.md` - `docs/ARCHITECTURE.md` - `docs/HARDWARE.md` +- `docs/dashboard-esp32s3.md` +- `docs/CONFIGURATION.md` - `docs/UART_PROTOCOL.md` - `docs/SERIAL_COMMANDS.md` - `docs/PARITY_MATRIX.md` -- `docs/wiring.md` - `docs/TEMP_SETUP.md` - `docs/ROADMAP.md` - `docs/CHANGELOG.md` diff --git a/docs/README.md b/docs/README.md index e12d332..a95dbf1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,14 +14,14 @@ This folder contains project documentation for Overland Controller. - `project-state.md` - Current project state - `roadmap.md` - Roadmap and future plans -- `hardware-status.md` - Hardware status and bring-up notes - `decisions.md` - Architecture and implementation decisions ## Technical References - `dashboard-esp32s3.md` - Current Waveshare ESP32-S3 dashboard plan -- `protocol.md` - Legacy UART protocol reference -- `wiring.md` - Older wiring notes; verify against `HARDWARE.md` before use +- `CONFIGURATION.md` - Configuration model and setup concepts +- `TEMP_SETUP.md` - DS18B20 temperature sensor setup +- `UART_PROTOCOL.md` - Optional UART diagnostics protocol ## Archive @@ -29,7 +29,6 @@ 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 diff --git a/docs/archive/legacy-current-cleanup/README.md b/docs/archive/legacy-current-cleanup/README.md new file mode 100644 index 0000000..9890434 --- /dev/null +++ b/docs/archive/legacy-current-cleanup/README.md @@ -0,0 +1,13 @@ +# Legacy Current-Cleanup Archive + +These files were moved out of the active docs during the June 2026 documentation cleanup. + +They are retained for historical reference only. Current source-of-truth docs are: + +- `docs/ARCHITECTURE.md` +- `docs/HARDWARE.md` +- `docs/ROADMAP.md` +- `docs/API.md` +- `docs/dashboard-esp32s3.md` + +Do not use the archived Pico/UART wiring or handoff notes for current implementation work. diff --git a/docs/HANDOFF.md b/docs/archive/legacy-current-cleanup/handoff.md similarity index 100% rename from docs/HANDOFF.md rename to docs/archive/legacy-current-cleanup/handoff.md diff --git a/docs/hardware-status.md b/docs/archive/legacy-current-cleanup/hardware-status.md similarity index 100% rename from docs/hardware-status.md rename to docs/archive/legacy-current-cleanup/hardware-status.md diff --git a/docs/protocol.md b/docs/archive/legacy-current-cleanup/legacy-uart-protocol.md similarity index 100% rename from docs/protocol.md rename to docs/archive/legacy-current-cleanup/legacy-uart-protocol.md diff --git a/docs/TEMP_API.md b/docs/archive/legacy-current-cleanup/temp-api.md similarity index 100% rename from docs/TEMP_API.md rename to docs/archive/legacy-current-cleanup/temp-api.md diff --git a/docs/wiring.md b/docs/archive/legacy-current-cleanup/wiring.md similarity index 100% rename from docs/wiring.md rename to docs/archive/legacy-current-cleanup/wiring.md diff --git a/hardware/archive/README.md b/hardware/archive/README.md new file mode 100644 index 0000000..f2754f4 --- /dev/null +++ b/hardware/archive/README.md @@ -0,0 +1,5 @@ +# Hardware Archive + +These pinout notes are legacy references from earlier dashboard and wiring plans. + +The current hardware source of truth is `docs/HARDWARE.md`, with the current dashboard plan in `docs/dashboard-esp32s3.md`. diff --git a/hardware/cat5-pinout.md b/hardware/archive/cat5-pinout-legacy.md similarity index 100% rename from hardware/cat5-pinout.md rename to hardware/archive/cat5-pinout-legacy.md diff --git a/hardware/esp32-pinout.md b/hardware/archive/esp32-pinout-legacy.md similarity index 100% rename from hardware/esp32-pinout.md rename to hardware/archive/esp32-pinout-legacy.md diff --git a/hardware/pico-pinout.md b/hardware/archive/pico-pinout-legacy.md similarity index 100% rename from hardware/pico-pinout.md rename to hardware/archive/pico-pinout-legacy.md diff --git a/hardware/uart-cat5-pinout.md b/hardware/archive/uart-cat5-pinout-legacy.md similarity index 100% rename from hardware/uart-cat5-pinout.md rename to hardware/archive/uart-cat5-pinout-legacy.md diff --git a/hardware/pinout.md b/hardware/pinout.md deleted file mode 100644 index e69de29..0000000