IndexBus crate groups

    This page is the public landing point for the three crate groups used throughout the IndexBus workspace: substrate, kit, and platform.

    Use it when you know roughly which layer you need, but not yet which crate or docs page should be your entry point.

    Substrate

    Substrate is the low-level indexbus-* surface: ABI layouts, core algorithms, transports, codecs, and low-level adapters.

    Start here when you need:

    • direct control over shared-memory layouts and validation,
    • queue, router, or sequencer primitives,
    • explicit transport and codec selection,
    • minimal dependencies and no_std-first building blocks.

    Representative crates:

    Best repo docs to pair with substrate rustdoc:

    Kit

    Kit is the application ergonomics layer centered on indexbus_kit.

    Start here when you need:

    • named lanes and safe constructors,
    • typed-message convenience on top of substrate primitives,
    • runnable “happy path” examples without hiding the underlying model.

    Best repo docs to pair with kit rustdoc:

    Crate-local README to consult without promoting into the public manifest:

    • crates/indexbus-kit/README.md

    Platform

    Platform is the std-first production scaffolding layer under the indexbus-platform-* family.

    Start here when you need:

    • lifecycle and supervision,
    • config, observability, HTTP, DB, auth, and OS-/host-level helpers,
    • a production app shape that builds on IndexBus rather than hiding it.

    Representative crates:

    Best repo docs to pair with platform rustdoc:

    Decision: do not promote more crate READMEs into the public manifest now

    Decision:

    • keep crate-level README.md files as crate-local companion material,
    • do not add more raw crate READMEs to docs/public-docs.json right now.

    Reasoning:

    • the public manifest should stay curated around stable spec, ops, reference, and layer-navigation pages,
    • crate READMEs are useful, but they move at a different cadence and are better treated as nearby crate documentation plus rustdoc companions,
    • when a crate group needs public exposition, prefer a stable repo-doc page like this one over publishing a raw README wholesale.

    That keeps the public Pages surface small and intentional while still leaving crate READMEs available in-repo for deeper implementation context.

    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