Documentation
Every architectural decision, task brief, code review, and validation run lives in markdown next to the code. This page is the index; all links go to the canonical source on GitHub.
A standalone docs site with search and versioned API reference comes later. For now, the markdown is the product record.
Project overview
What OpenWebHMI is, what it isn't, where it's going.
-
README ↗
Quick orientation: vision, stack, scope envelope, roadmap headline.
-
Architecture ↗
Full v1 system design — components, data flows, failure modes, security boundaries.
-
Roadmap ↗
Phase 0 → 1.0 plan with concrete exit criteria per phase.
-
Feature matrix ↗
Side-by-side feature catalog vs Ignition and Optix; v1 / post-1.0 / not-planned markers.
-
Stack rationale ↗
Why Rust + Python + TypeScript instead of Java/Jython or C#/.NET. The AI/ML differentiator.
-
Scale estimates ↗
Expected lines of code per component for v1.0 (target floor 2M), with actuals tracked over time.
For contributors
How to add drivers, components, scripts, and how the PR / review workflow runs.
-
Contributing guide ↗
Plugin extension model (drivers / components / scripts) and the local-dev runbook.
-
Driver wiki — rust-ethernet-ip ↗
How driver-rockwell wraps the upstream EtherNet/IP crate, with versioned source citations and the upgrade workflow.
-
Engineering wiki ↗
Synthesized engineering knowledge — vendor quirks, validation results, decision rationale.
For AI agents (and humans following the same playbook)
OpenWebHMI is built collaboratively by Claude (design + review) and Codex (development + debug). All hand-offs are durable in markdown.
API reference
Auto-generated rustdoc for the workspace crates. Available locally:
cargo doc --workspace --no-deps --open
A hosted rustdoc at docs.openwebhmi.com ships with v1.0.