README.md

Documentation

This repository has two documentation layers:

• Operational docs: install, run, and debug the runtime.
• Reference docs: generated API and framework detail.

Start here

1. Installation and setup
2. Quick start
3. Deployment options

Guides

Examples and usage guides

• Publish/Subscribe Basics
• Service and Client
• Parameter Service
• Record and Replay
• Python Quick Start
• Zero-Copy and Sensor Data

Additional operational guides

• Secondary development and integration
• Release and verification
• Release validation
• Performance testing
• Component development
• Tools and monitoring
• Topology and transport
• Common issues

Examples

• Common component example
• Timer component example

Reference

• Generated API index
• C++ API
• Python API
• C++ API guide
• Python API guide
• Terms

Structure

Use operational docs for the primary workflow. Use generated API docs for implementation details, signatures, and deeper runtime concepts.