From aee7106fd5c90b5b43e6d5cf840c2816e96b8909 Mon Sep 17 00:00:00 2001 From: Andreas Johannsen Date: Mon, 27 Apr 2026 17:43:47 +0200 Subject: [PATCH] fix: LCGUI import path and landing page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - keep_docs_dir: false removes the spurious docs/ prefix from URLs (pages now at /lcgui/LCGUI-SPEC/ instead of /lcgui/docs/LCGUI-SPEC/) - Add local lcgui/index.md landing page (mirror repo can't be written) - Fix index.md LCGUI link case: LCGUI/ → lcgui/ Co-Authored-By: Claude Sonnet 4.6 --- docs/index.md | 4 ++-- docs/lcgui/index.md | 29 +++++++++++++++++++++++++++++ mkdocs.yml | 2 +- 3 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 docs/lcgui/index.md diff --git a/docs/index.md b/docs/index.md index ed3bc69..58c37f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,11 @@ Welcome to the documentation hub of Daelon Engineering UG. [:octicons-arrow-right-24: Documentation](LiquidCore15/telemetry-interface.md) -- :material-monitor-dashboard: **[LCGUI](LCGUI/)** +- :material-monitor-dashboard: **[LCGUI](lcgui/)** Operator interface for the LiquidCore platform. - [:octicons-arrow-right-24: Documentation](LCGUI/) + [:octicons-arrow-right-24: Documentation](lcgui/) diff --git a/docs/lcgui/index.md b/docs/lcgui/index.md new file mode 100644 index 0000000..bce3a7a --- /dev/null +++ b/docs/lcgui/index.md @@ -0,0 +1,29 @@ +# LCGUI + +**LCGUI** is the LC15 engineering dashboard — a desktop Python GUI that connects to the LC15 inverter firmware over UDP and provides live telemetry, FSM state, fault decoding, command control, and data logging at 100 Hz. + +## Documents + +| Document | Description | +|----------|-------------| +| [Specification](LCGUI-SPEC.md) | Full implementation spec: architecture, widgets, data flow | +| [Design System](DESIGN.md) | Visual language and UI design reference | +| [External Contract](EXTERNAL_IMPL.md) | External implementation contract for conforming GUIs | +| [UDP Injector](INJECTOR.md) | Synthetic telemetry injection for testing | +| [LC15 HW Communications](LC15-HW-COMMS.md) | Hardware communication layer reference | +| [Telemetry Interface](telemetry-interface.md) | Telemetry frame format and integration | +| [UI Spec](15-UI-SPEC.md) | UI component specification | + +## Protocol Reference + +Generated from the firmware protocol definitions: + +| Document | Description | +|----------|-------------| +| [Protocol Overview](generated/protocol-overview.md) | End-to-end protocol summary | +| [Telemetry Frame](generated/telemetry-frame.md) | 63-byte telemetry frame spec | +| [Command Frame](generated/command-frame.md) | Command frame format | +| [Calibration Frame](generated/calibration-frame.md) | Calibration data frame | +| [CRC Specification](generated/crc-specification.md) | CRC16-CCITT details | +| [Derived Metrics](generated/derived-metrics.md) | Computed fields from raw telemetry | +| [Test Vectors](generated/test-vectors.md) | Protocol test vectors | diff --git a/mkdocs.yml b/mkdocs.yml index 4eb2289..76bb07e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -47,7 +47,7 @@ plugins: - search - multirepo: cleanup: true - keep_docs_dir: true + keep_docs_dir: false nav: - Home: index.md