From 5b62d2ddfdeb0eb55c5b5e2cde1c81e0a2fb490f Mon Sep 17 00:00:00 2001 From: root Date: Wed, 3 Jun 2026 02:31:00 -0600 Subject: [PATCH] Add documentation index and source of truth references --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 02bfc09..14f2292 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,41 @@ A custom monitoring and control system for a Nissan Xterra using: 4. Temperature sensors 5. JBD/Xiaoxiang BMS integration 6. Future integrations / optional logging + +## Documentation + +### Project Status + +* `docs/project-state.md` +* `docs/hardware-status.md` + +### System Design + +* `docs/architecture.md` +* `docs/protocol.md` +* `docs/pico-architecture.md` + +### Hardware + +* `docs/uart.md` +* `docs/wiring.md` +* `hardware/bom.md` +* `hardware/esp32-pinout.md` + +### User Interface + +* `docs/ui-wireframes.md` + +### Development + +These documents should be considered the source of truth for ongoing development. + +Priority order: + +1. `docs/project-state.md` +2. `docs/hardware-status.md` +3. `docs/protocol.md` +4. `docs/pico-architecture.md` +5. `docs/ui-wireframes.md` + +Implementation should follow documented architecture unless explicitly updated in the documentation first.