#IndexBus Docs
Synced 13 manifest-selected docs pages from IndexBus.
Synced docs namespace
This namespace is generated from indexbus/docs/public-docs.json. The pages below are synced into the central Rspress app rather than mirrored as a second HTML docs site.
#Canonical Surfaces
Rustdoc reference
Curated rustdoc entry points for this namespace.
Source repository
GitHub source for the owning repository.
#Synced Pages
IndexBus architecture overview (v1, non-normative)
This document gives a big-picture view of IndexBus as implemented in this repository. It is non-normative: for exact behavioral contracts, see the v1 spec.
IndexBus v1 production profile: scope, blessed paths, stability
This document defines the v1 production profile for IndexBus as shipped in this repository:
IndexBus crate groups
This page is the public landing point for the three crate groups used throughout the IndexBus workspace: substrate, kit, and platform.
v1 conformance tests guide (non-normative)
This guide describes how to validate IndexBus v1 behavior using a conformance-style test suite.
Lanes (v1): core execution patterns
IndexBus has a small set of standard execution patterns that show up across crates, examples, and ops guidance.
Performance & tuning guide (v1, best-effort)
This is best-effort guidance for getting predictable performance out of IndexBus v1.
Router counters reference (v1, best-effort)
This document defines the intended meaning of counters printed by the v1 router loop tools.
Troubleshooting map
This page maps common IndexBus symptoms to the best repo docs and rustdoc entry points.
IndexBus Ops Triage (v1)
Goal: answer “why is it slow/dropping?” using only:
`indexbus-msg` v1 envelope reference (descriptive)
This page is a focused reference for the v1 structured envelope used by indexbus-msg.
IndexBus v1 layouts reference (descriptive)
This document is a descriptive reference to help readers navigate v1 shared-memory layouts.
IndexBus Failure & Lifecycle (normative, v1)
This document defines how IndexBus v1 behaves under failures and lifecycle events.
IndexBus Semantics (normative, v1)
This document defines normative semantics for IndexBus v1 as implemented in this repo.
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.