Skip to content
CMMD Docs

Documentation Model

CMMD documentation is split by visibility.

Public docs explain what external consumers can safely know: product concepts, install steps, public APIs, package usage, and release history.

Internal docs contain private operating knowledge: implementation plans, runbooks, incidents, security process, customer context, and architectural decisions that should not be public.

Code repositories still keep code-adjacent truth close to implementation. This central docs site publishes the curated version.

Rules

Section titled “Rules”
  • Keep package-specific docs in the owning repository first.
  • Publish polished, durable docs here.
  • Automate generated references and release notes.
  • Require human review for conceptual or strategic docs.
  • Never store secrets in documentation.