Skip to content

Documentation boundary

Defines the documentation source of truth and the boundary between runtime distribution and published documentation.

Standard

  • HybridOps.Core is a runtime distribution.
  • Long-form documentation is published on the docs site.
  • The docs site is the canonical source for contracts, runbooks, guides, and ADRs.
  • Runtime distributions may include concise CLI help output and installer usage text only.
  • Documentation content must not be duplicated into runtime distributions.

Scope

Applies to:

  • contracts and annexes
  • runbooks and operational procedures
  • guides and HOWTO content
  • ADRs and architecture references
  • examples and tutorials beyond CLI help

Offline availability

The docs site MAY be available offline (for example via a PWA offline cache). Long-form documentation remains outside the runtime distribution by default.

Compliance

Repository checks should prevent documentation libraries from being introduced into the runtime distribution.