Design Documents

Design documents provide detailed implementation guidance for CCM’s resource types, providers, and internal components. They are intended for developers contributing to CCM or those seeking to understand specific implementation details.

For end-user documentation on how to use resources, see Resources.

Note

These design documents are largely written with AI assistance and reviewed before publication.

Contents

Each design document covers:

  • Purpose and scope: What the component does and its responsibilities
  • Architecture: How the component fits into CCM’s overall design
  • Implementation details: Key data structures, interfaces, and algorithms
  • Provider contracts: Requirements for implementing new providers
  • Testing considerations: How to test the component

Available Documents

  • Archive Type: Archive resource for downloading and extracting archives
  • Apply Type: Apply resource for composing manifests from reusable parts
  • Exec Type: Exec resource for command execution
  • File Type: File resource for managing files and directories
  • Package Type: Package resource for system package management
  • Scaffold Type: Scaffold resource for template directory rendering
  • Service Type: Service resource for system service management
  • Adding a Type: How to add a new resource type to CCM
  • Docs Style Guide: Define writing conventions for CCM documentation