Spec Authoring

    Pipeline specs in ByteOr are structured documents describing what a pipeline does, how it is connected, and what execution constraints apply. The OSS crate workspace owns the canonical authoring surface.

    The Spec Format

    ByteOr uses a deterministic key-value (KV) format:

    • UTF-8 text with one key=value pair per line
    • Deterministic — the same logical spec always produces the same byte-for-byte encoding
    • Canonicalizable and diff-friendly

    Source Authoring Contract

    The supported authoring surface is PipelinePlanV2. This is the source contract for both execution targets.

    Builder-First Rule

    The builder API in byteor-pipeline-spec is the baseline authoring contract. Macros are optional ergonomics built on top of the builder.

    OSS Crate Surface

    • byteor-pipeline-spec — the spec data model and builder API
    • byteor-pipeline-plan — plan types and target payloads
    • byteor-pipeline-macros — optional proc-macro ergonomics

    Canonical Docs Surface

    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.
    Source-of-truth modelRepo docs index