documents

Canopy Documentation

Use this directory by task, not by file number.

Start Here

• New to Canopy:
  • Introduction
  • Getting Started
  • External Project Guide
• Best first hands-on path:
  • External Project Guide
  • then the example consumer app linked from the root README
• Building and testing the primary implementation:
  • Build And Test
  • C++ Build And Test Guide
• Understanding the runtime:
  • Architecture
  • Transports
  • Serializers
  • Security Notes
• Looking up APIs and patterns:
  • API Reference
  • Examples
  • Best Practices
  • Clang-Tidy Coding Guidelines
  • REST Clients

Implementation Status

• C++ Status
• Rust Status
• JavaScript Status

Language Port Material

• Rust Port Documentation

Serialization

• YAS Serializer
• Protocol Buffers
• Nanopb

How To Read These Docs

• The primary implementation is C++.
• Many documents describe shared Canopy concepts through the C++ implementation.
• When a document is implementation-specific, it should say so near the top.
• If a document and the code disagree, prefer the live code and CMake files.