Docs
Wire-format reference, how-to guides, operational runbooks, and design background for the OCX public index — for package publishers and index operators. Organised by task type (Diátaxis): reference for looking things up, how-to for getting something done, ops for running the index itself, explanation for the reasoning behind it.
Reference
Look something up. Precise, exhaustive, no narrative.
- Wire Format — the four frozen URL shapes, field semantics, freshness,
format_versiongating - Entry Schema — full field table for the package root and the OCI image index
- Namespace Policy — the
<namespace>/<package>charset, reserved segments, dispute policy - Governance Contracts — the G-01–G-20 automated/human review contracts
- Changelog —
format_version-keyed history
How-To
Get a specific task done.
- Announce a Package — trigger the bot to re-observe your registry and refresh your entry
- Claim a Namespace — first-claim PR flow
- Yank a Version — mark a tag row yanked
Ops
Run the index itself.
- Run a Reconcile Dry Run
- M-1 Flip — enabling live reconcile writes
Explanation
Understand why it works this way.
- Architecture — the locked-index model, the verifiability chain, why the index is copied, not the manifest