Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.06 KB

File metadata and controls

34 lines (26 loc) · 1.06 KB

Operator docs index

This folder is the mutable operator-facing documentation entrypoint.

Read in this order:

  1. ../../README.md
  2. profiles.md
  3. defaults.md
  4. policies.md
  5. origin.md
  6. observability.md
  7. cli.md
  8. public.md
  9. ../LIFECYCLE_AND_EMBEDDED_SERVER.md
  10. ../review/conformance/state/CURRENT_REPOSITORY_STATE.md

What belongs here:

  • CLI usage and flag-family guidance
  • blessed deployment profile guidance
  • generated default/help parity tables and profile-effective default audits
  • generated proxy-contract, precedence, policy-surface, QUIC semantic contract tables, and the origin/static/pathsend contract
  • generated observability/export-adapter/qlog contract tables
  • public operator/programmatic surface docs
  • operator-focused examples and pointers into conformance materials

What does not belong here:

  • immutable release artifacts
  • canonical current-state reports
  • release-root bundle material

When public CLI or API behavior changes, update this folder together with code, tests, machine-readable truth files, and README.md.