Architecture docs are split by subsystem. Read only what's relevant to your current work.
For a full FAQ-style index of every doc in this repo (human + LLM entry point), see INDEX.md.
| Working on crate | Read these |
|---|---|
fbuild-cli |
overview.md, data-flow.md |
fbuild-daemon |
overview.md, runtime.md |
fbuild-serial |
serial.md, deploy-preemption.md |
fbuild-python |
serial.md, pyo3-bindings.md |
fbuild-build |
overview.md, data-flow.md |
fbuild-deploy |
deploy-preemption.md |
fbuild-config |
overview.md |
fbuild-packages |
overview.md |
fbuild-paths |
overview.md |
fbuild-core |
overview.md |
fbuild-header-scan / fbuild-library-select |
library-selection.md |
| Platform-specific issues | portability.md |
- INDEX.md - FAQ-style index across all docs
- WHY.md - Why fbuild exists, key benefits, performance
- BOARD_STATUS.md - Per-platform CI badges and supported boards
- DEVELOPMENT.md - Testing, troubleshooting, local setup
- CI_CACHE.md - Consumer-facing cross-run CI cache strategy
- DESIGN_DECISIONS.md - ADR-style decisions with rationale
- ROADMAP.md - Implementation phases
- ARCHITECTURE.md - Index of all architecture documents
- ../crates/CLAUDE.md - Crate dependency graph and boundaries
- ../PLAN_QEMU_ESP32S3.md - QEMU ESP32-S3 emulation plan
- Emulator CLI:
fbuild test-emu(build + emulate) andfbuild deploy --to emu [--emulator <kind>]