This page is the canonical map of Rivet documentation. Start with one path and follow links only when the work crosses that boundary; the root README remains a product overview rather than a second documentation index.
- Getting started · 中文
- Project configuration
- Diagnostics and cleanup
- Continuous integration · 中文
- Agent-native development
- Architecture — process, runtime, UI, Android, and service boundaries
- RVT1 protocol and runtime limits
- Racket CS embedding
- API stability · 中文
- Large payloads, pagination, and progress
- System services
- Windows host integration
- Linux display policy
- Real-time chart series
- Typed device communication
- Network device channel design — policy/pairing cores implemented; network transport not shipped
- Package verification
- Production signing
- Release and updates
- Releasing the Rivet framework
- Native UI end-to-end testing
- Protocol fuzzing and performance benchmarks
- Desktop closeout and mobile start plan
Each topic has one canonical owner. Add a new page only when it defines a
durable boundary that cannot fit an existing owner; status snapshots and
completed milestones belong in the active plan or changelog, not permanent
standalone pages. When deleting or merging a page, update all repository links
and run raco test rivet/tests/documentation.rkt.
Active plans are temporary. When their exit gates close, move lasting decisions
and operating instructions into the canonical guides above, record the release
result in CHANGELOG.md, and delete the plan instead of preserving a second
history of the same feature. Durable protocol and security rationale stays in
its owning guide until the implementation supersedes it.