Reference Hub

This page is the stable reference entry point for the ByteOr documentation ecosystem.

Reference entry point

This page is intentionally link-heavy. When a topic becomes repo-specific or contract-level, prefer the synced repo docs and same-site rustdoc listed here over hand-maintained prose duplication.

Use it when you need repo docs, same-site rustdoc, generated headers, or the cross-repo ownership map rather than the editorial summaries in the main site sections.

Synced repo surfaces

IndexBus Docs

Synced public repo docs for the transport substrate and shared-memory contracts.

IndexBus Rustdoc

Crate-level and type-level API reference for IndexBus.

ByteOr OSS Docs

Synced public repo docs for deterministic plans, execution, ABI, and validation.

ByteOr OSS Rustdoc

Crate-level and type-level API reference for the ByteOr OSS workspace.

Headers and low-level contracts

ABI and Headers

Generated C headers and ABI compatibility guidance for ByteOr and IndexBus.

The compact key-value representation used across plans and related artifacts.

Artifact Schemas

Canonical schema surfaces for emitted artifacts and related contracts.

How stages are named, linked, and tracked across execution surfaces.

Machine-readable indexes

Machine-Readable Indexes

Overview page for published JSON indexes and their intended consumers.

Headers JSON

Published index of generated public header bundles.

API Resource Families JSON

Published index of API resource family metadata.

Cross-repo ownership map for ByteOr, Cloud, Enterprise, and IndexBus.

Synced Repo Docs

Public repo-owned docs selected from the open IndexBus and ByteOr OSS repositories and published under one shared namespace.

Operator and platform reference

Environment Variables

Runtime configuration surface for services, agents, and supporting tools.

RBAC and Permissions

Role and permission model for operator-facing access control.

Public security posture and responsible disclosure guidance.

Support expectations and stability guarantees across ByteOr surfaces.

Provenance

Need the source docs?

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