ByteOr workspace map

    This page ties the public OSS crates to the docs pages and rustdoc entry points you should start from.

    Public workspace crates

    CrateResponsibilityStart with docsRustdoc
    byteor-abiexported repr(C) layouts and the generated ByteOr header contractarchitecture/overview.md, policy/abi-compatibility.mdbyteor_abi
    byteor-pipeline-specv1 spec model, validation, canonical kv, and describe helpersspec/v1-semantics.md, reference/kv-format.md, reference/lanegraph-model.mdbyteor_pipeline_spec
    byteor-pipeline-planmodel-neutral authoring contract and target-aware planning envelopearchitecture/source-authoring-contract-v2.md, reference/source-authoring-target-matrix.mdbyteor_pipeline_plan
    byteor-pipeline-lowerexplicit lowering from PipelinePlanV2 into canonical runtime specsarchitecture/overview.md, reference/source-authoring-target-matrix.mdbyteor_pipeline_lower
    byteor-pipeline-kernelhot-path lane traits, sequencing, and wait primitivesarchitecture/overview.md, contract/v1-production-profile.mdbyteor_pipeline_kernel
    byteor-transport-shmfile-backed SHM transport open/create/validate layerpolicy/shm-threat-model.md, spec/v1-failure-lifecycle.mdbyteor_transport_shm
    byteor-pipeline-backings-memin-memory backings for tests and deterministic local pathsarchitecture/overview.mdbyteor_pipeline_backings_mem
    byteor-pipeline-backings-shmSHM-backed lane implementations and attach/create helpersarchitecture/overview.md, policy/shm-threat-model.mdbyteor_pipeline_backings_shm
    byteor-pipeline-execexecutor and runtime bring-up helperscontract/v1-production-profile.md, spec/v1-failure-lifecycle.mdbyteor_pipeline_exec
    byteor-pipelinefacade crate re-exporting the main OSS surfacearchitecture/overview.md, guides/spec-authoring.mdbyteor_pipeline
    byteor-pipeline-wasmbrowser-facing authoring and validation bindingsarchitecture/overview.md, guides/spec-authoring.mdbyteor_pipeline_wasm

    Internal or non-published workspace members

    • byteor-pipeline-macros is currently publish = false and should be treated as internal workspace scaffolding, not a public API contract.
    • apps/byteor-example, bench/byteor-bench, and xtask are useful workspace tools, but they are not the core public API entry points for OSS consumers.

    If you are trying to understand...

    • the stable spec contract: start with byteor-pipeline-spec.
    • the authoring-to-runtime path: move from byteor-pipeline-plan to byteor-pipeline-lower to byteor-pipeline-spec.
    • runtime execution and SHM attachment: move from byteor-pipeline-kernel to byteor-transport-shm to byteor-pipeline-exec.
    • C-facing integration: start with byteor-abi and the generated spec/byteor_v1.h header.

    Use ../reference/rustdoc.md for the public rustdoc landing page and ../reference/release-versioning.md for release-line expectations across docs, headers, and rustdoc.

    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