Documentation
What is designed is marked as design. What ships will be documented as it ships.
Today the documentation is the platform's design: the provenance model, the importer and connector contract, the API and MCP surface, and a glossary. User and operator documentation lands with the first release.
Platform design Planned
The provenance model
Observed, imported, inferred, confirmed. Assertions, snapshots, questions, redaction.
Importers and connectors
The two interfaces, binding hints, and how a model built offline goes live.
API and MCP
Resources shaped like the model, one authorization check, read-only tools, scoped queries.
Glossary
The words this site uses, defined once.
With the first release Planned
- Getting started. Download, verify, import a backup, open the local address, answer the first questions.
- Operator guide. Navigation, equipment views, point tables, alarms, histories, the questions queue, provenance on every screen.
- Importers. One page per format: what it reads, what it cannot see, the coverage report, known quirks.
- Connectors. One page per connector: setup, scope, permissions it needs, resource limits, how to remove it.
- API and MCP reference. Generated from the same schemas the runtime serves offline.
- Operations. Backup (one folder), upgrade, roll back, the offline tests you can run yourself.
Elsewhere
- Architecture: shape, interfaces, boundaries, technology.
- Security: promises, threat model, supply chain, disclosure.
- Repository: decision records, contributing guide, code as it lands.