GUIDE

The framework, one chapter at a time. Each chapter is reconciled against a doc in the bytesandbrains repository and stamped with the source path at the top of the page. Read in order for the first pass, jump in by surface after that.

1. Chapter 01 Introduction What bytesandbrains is, what a Module records, and where the framework sits in the stack.
2. Chapter 02.1 Install Toolchain requirements, cargo add bytesandbrains, the 0.3 crate family, and the contributors source build.
3. Chapter 02.2 Getting Started One example, end to end. From Module body to a polled Node in a single file.
4. Chapter 03 The IR and the DSL How the Graph recorder fills the ONNX ModelProto that the rest of the framework reads.
5. Chapter 04 Syscalls Reference Every framework syscall: domain, op type, inputs, outputs, attributes, firing behavior.
6. Chapter 05 Authoring Modules and Components Defining a Module, declaring ports, and registering concretes with the inventory.
7. Chapter 06 Roles and Contracts The eight Contract roles the engine dispatches against and the trait family behind them.
8. Chapter 07 Dependencies #[depends(...)] on bb::Concrete and the compile-time wiring between sibling components.
9. Chapter 08 Types and Storage The hierarchical type lattice the compiler solves and the metadata it stamps onto the IR.
10. Chapter 09 The Compiler The bind chain, the pipeline, and the typed CompileError variants that surface malformed input.
11. Chapter 10 The Engine A sans-IO Node::poll driven by the host, with a single frontier and a lock-free ingress queue.
12. Chapter 11 Wire and Addressing One WireEnvelope per cross-Node edge, multiaddr destinations, and the wire-cutting compiler passes.
13. Chapter 12 Deployment How the same ModelProto runs in-process for tests and across hosts in production.
14. Chapter 13 Examples Tour A guided read through the runnable programs in the examples/ directory.