Audit Response¶
How each finding from the original audit (preserved at _meta/audit/DOCS_AUDIT.md outside the published site) was
addressed in this consolidation. Status legend:
- Fixed — the audit issue is resolved in the relevant
docs/document. - Documented — not directly fixed, but explicitly noted (e.g.
in
LICENSES.mdas TODO, inWEB_API.mdas STUB). - Out of scope — the issue is in the source repository, not in the consolidation; logged here for the next sync round.
Contradictions (C1–C5)¶
| ID | Issue | Status | Where |
|---|---|---|---|
| C1 | DEVELOPER_GUIDE.md "three gates" intro vs. "The four gates" subsection | Fixed | host/docs/DEVELOPER_GUIDE.md §"WLED OTA gate matrix" intro now says "four gates: three host-recoverable HTTP-401 gates plus one HTTP-500 gate". |
| C2 | Plans use historical names (OPC_CONTROL_ADV, etc.) |
Out of scope | Plans are not part of this consolidation. The current naming is canonical in PROTOCOL.md and GLOSSARY.md. |
| C3 | Licence reporting inconsistent | Documented | LICENSES.md lists per-component licences; placeholders flag the four _to be confirmed_ entries that need source-LICENSE-file inspection. |
| C4 | Plan index drift (4 plans not in plans/README.md) |
Out of scope | Plans are not consolidated; the source repo's plans/README.md should be updated at next sync. |
| C5 | Plans missing > **Status:** blocks |
Out of scope | Same as C4. |
Outdated / stale content (O1–O10)¶
| ID | Issue | Status | Where |
|---|---|---|---|
| O1 | host/README.md Windows-absolute-path link |
Fixed | host/README.md line 42: link now reads [docs/standalone.md](docs/standalone.md) (relative, resolves correctly). |
| O2 | .claude/plans/... references |
Fixed (host docs) | Replaced with text references in host/ARCHITECTURE.md §"Audit trail" and host/docs/DEVELOPER_GUIDE.md §"Adding a scene-action kind" / §"Smoke-testing your change". |
| O3 | ../WLED LoRa/... workstation paths |
Fixed (mostly) | DEVELOPER_GUIDE's "WLED OTA gate matrix" intro replaced with upstream-WLED reference; `Updating the WLED-deterministic effects list" intro made tooling-agnostic. Two remaining occurrences (lines 346 and 354 of DEVELOPER_GUIDE) are intentional "default workstation path" hints in the How to regenerate instructions and were left to preserve operational context. |
| O4 | plans/plane-f-r-mich-ein-refactored-boole.md uses OPC_CONTROL_ADV |
Out of scope | Plan archive not migrated. |
| O5 | plans/mache-einen-genauen-diff-splendid-sunbeam.md operational task |
Out of scope | Plan archive not migrated; tracked in HARVEST.md. |
| O6 | Top-level README surfaces plans/ as public navigation |
Fixed | index.md lists no plans/ entries; plans are entirely absent from the consolidation. |
| O7 | PROTOCOL.md "Retired" EV_* events |
Documented | The PROTOCOL.md content is a verbatim copy and already explicitly says "do not use, byte values reused" for the retired events — a future revision could promote that to an admonition. |
| O8 | gateway/README.md "Current project structure" tree |
Out of scope | Source-repo content; not a fix the consolidation can apply alone. |
| O9 | racelink_proto.h lives in three places |
Documented | The three-way duplication and the regression test that pins parity is documented in CONTRIBUTING.md "Smoke tests" + the host/docs/PROTOCOL.md §"Versioning". |
| O10 | Plans without status quotes | Out of scope | Plan archive. |
Duplications (D1–D10)¶
| ID | Issue | Status | Where |
|---|---|---|---|
| D1 | "What is RaceLink" intro paragraph in 5 files | Fixed | Canonical intro in index.md. The four sub-project READMEs now point readers there for the system-level intro, with their own per-component intros kept for repository-local context. |
| D2 | ASCII system diagram in 3 files | Fixed | Canonical diagram in index.md §"System overview". Sub-project READMEs reference it; the duplicate diagrams in gateway/README.md and wled/README.md were removed. |
| D3 | Component table in 5 files | Fixed | Canonical table in index.md. gateway/README.md and wled/README.md "Integration" / "Related repositories" sections now point to the canonical table. |
| D4 | Host-owned import edge / hosting modes in 3 files | Fixed | Long version stays in host/ARCHITECTURE.md (with repo_split_map.md content folded into the new §"Repo Split History"). The standalone repo_split_map.md is no longer mirrored. |
| D5 | Gateway state machine in 3 files | Documented | All three views kept (PROTOCOL.md = canonical wire, OPERATOR_GUIDE.md = master pill, ARCHITECTURE.md = transport view); cross-links exist between them. |
| D6 | OTA gate explanation in 2 files | Fixed | Operator-side keeps symptoms; developer-side keeps the matrix. C1 also fixes the within-DEVELOPER_GUIDE wording. |
| D7 | "Forget master MAC" in multiple files | Fixed | Operator-side canonical in host/docs/OPERATOR_GUIDE.md; operator-friendly cross-link from wled/OPERATOR.md. |
| D8 | Standalone install vs Host README "Hosting modes" | Documented | host/docs/standalone.md is canonical. host/README.md keeps a short pointer to it (already does). |
| D9 | Release flow info inside host/README.md |
Documented | Kept in host/README.md for now; flagged as a candidate for the maintainer area in the future MkDocs migration (DOCS_STRUCTURE_PROPOSAL.md §3.4). |
| D10 | RotorHazard plugin release flow in 2 files | Documented | rh-plugin/docs/release-playbook.md is the short maintainer playbook; rh-plugin/README.md § "Release Process" gives the overview. Both kept (one is summary, one is detail). Future MkDocs structure consolidates them. |
Documentation gaps (G1–G15)¶
| ID | Issue | Status | Where |
|---|---|---|---|
| G1 | Hardware BOM / Getting started | Documented | Acknowledged in index.md §"Recommended entry points by audience" → operators link to wled/README.md for hardware profile choice. A full BOM still requires per-profile hardware product naming and is left for a future revision. |
| G2 | Gateway operator setup | Fixed | New file gateway/OPERATOR.md. |
| G3 | WLED-node operator setup | Fixed | New file wled/OPERATOR.md. |
| G4 | RotorHazard plugin operator guide | Fixed | New file rh-plugin/OPERATOR.md. |
| G5 | Single canonical glossary | Fixed | New file GLOSSARY.md. |
| G6 | Network/RF planning guide | Documented | Short section in gateway/OPERATOR.md §"Radio defaults" + a regional note. Full guide (regional regulations, antenna placement, range tables) is a future revision. |
| G7 | Versioning policy | Fixed | New file VERSIONING.md. |
| G8 | Test strategy / Contributing guide | Fixed | New file CONTRIBUTING.md. |
| G9 | Changelog / release notes | Fixed (stub) | New file CHANGELOG.md with a template; populating from each repo's release tags is ongoing work. |
| G10 | Scene editor reference | Fixed (file shape) | New file reference/SCENE_FORMAT.md covers the on-disk format. A frontend-/UX-shaped Scene-editor reference (cost-estimator contract, capability gating UI, per-action widgets) is left for the future MkDocs migration. |
| G11 | Web API reference | Fixed (stub) | New file reference/WEB_API.md lists every endpoint referenced from the migrated docs. Request/response shapes are a TODO when source code is available. |
| G12 | SSE channel reference | Fixed | New file reference/SSE_CHANNELS.md. |
| G13 | ADR collection | Fixed | New folder maintainer/adr/ with ADR-0001 and an index of ADR candidates harvested from plans. |
| G14 | FAQ / Troubleshooting index | Fixed | New file TROUBLESHOOTING.md — single index pointing into the canonical pages. |
| G15 | Search-friendly landing page | Fixed | index.md is the EN landing page now (replaces the German root README). |
Translation status (user requirement #2)¶
All consolidated documents in docs/ are in English. The two
originally-German files (root README.md and SOURCES.md) were
translated; everything else was already English.
The plan files in plans/ (some of which are German, some
English) are deliberately not mirrored — per the user's
chosen strategy, only the public-relevant content was harvested
into the English public docs (see HARVEST.md).
Plan-archive treatment (user requirement #1)¶
Per the user's chosen strategy: plans are not part of the public
documentation. The plan archive in the source repo's plans/
folder is left intact; only the relevant content was harvested
(see HARVEST.md).