#ByteOr OSS Docs
Synced 15 manifest-selected docs pages from ByteOr OSS.
Synced docs namespace
This namespace is generated from byteor/docs/public-docs.json. The pages below are synced into the central Rspress app rather than mirrored as a second HTML docs site.
#Reference Surfaces
Rustdoc reference
Curated rustdoc entry points for this namespace.
Source repository
GitHub source for the owning repository.
#Synced Pages
Architecture overview (ByteOr OSS)
ByteOr is an OSS pipeline/runtime substrate. The workspace is intentionally split so the deterministic spec model, hot-loop kernel, SHM transport, and executor layers can evolve with auditable boundaries.
ByteOr v1 production profile
This document describes the recommended path through the ByteOr OSS workspace for users who want a clear, supportable baseline.
Benchmarking
This page explains how the ByteOr OSS workspace publishes benchmark evidence and how to compare those numbers safely.
Spec authoring path (ByteOr OSS)
This guide records the supported v1 path from author intent to a concrete PipelineSpecV1.
Worked examples (ByteOr OSS)
This guide gives a compact public worked-example surface for the ByteOr OSS workspace.
ByteOr workspace map
This page ties the public OSS crates to the docs pages and rustdoc entry points you should start from.
SHM threat model (ByteOr OSS)
ByteOr's SHM path is designed for high-throughput local IPC, not as a trust boundary by itself.
Stability policy (ByteOr OSS)
ByteOr OSS is currently pre-1.0.
KV format reference (ByteOr OSS)
This document describes the stable line-oriented kv format used by byteor-pipeline-spec::{encodekvv1, decodekvv1}.
LaneGraph reference (ByteOr OSS)
This document describes the current v1 LaneGraph model as implemented by byteor-pipeline-spec validation.
Release and versioning expectations
This page ties together the public release surfaces that need to stay aligned for every ByteOr OSS release line:
Rustdoc reference landing
The central docs site does not currently publish a workspace rustdoc snapshot. This page records the public OSS crate entry points that matter when the API-level surface is reviewed alongside the prose docs.
Source Authoring Target Matrix
This document records the current OSS support matrix for the full-parity source authoring contract.
ByteOr v1 failure and lifecycle
This document defines the normative failure and lifecycle behavior for the ByteOr OSS v1 runtime surface.
ByteOr v1 semantics
This document defines the normative v1 behavior for the ByteOr OSS spec surface.
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.