Stability Policy

This page describes the current public stability posture for ByteOr Cloud.

Stable enough to document publicly

The public docs should describe:

  • the tenancy hierarchy
  • the distinction between drafts, versions, bundles, deployments, agents, approvals, and artifacts
  • hosted environment naming and the broad API surface family
  • approval-aware deployment and replay behavior

Not yet treated as frozen contracts

The public docs should avoid presenting unstable implementation detail as if it were a durable API contract.

  • no generated OpenAPI reference is published yet
  • exact endpoint payload catalogs are deferred until a stable schema source exists
  • UI ergonomics and editor affordances may change faster than the underlying resource model

Practical rule

Keep the public repo docs focused on stable resource families, lifecycle states, and operator expectations. Publish generated endpoint-by-endpoint reference only when the source-of-truth contract is ready to carry that weight.

Provenance
Need the canonical source?
Use the public hub to orient yourself, then jump to repo-owned docs or rustdoc when you need contract-level detail.