Skip to content

CLAUDE.md

Latest commit

 

History

History
47 lines (40 loc) · 3.12 KB

CLAUDE.md

File metadata and controls

47 lines (40 loc) · 3.12 KB
Raw

Documentation Guide

Agents: for task-specific routing (which fbuild subcommand to run, how deploy actually works, DTR/RTS rules), see the root ../CLAUDE.md routing table and ../agents/docs/. This doc maps each crate to the right architecture doc; the agents/ docs map each task to the right command and contract.

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.

Which doc to read

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

Other docs

  • 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
  • symbols.md - fbuild symbols per-symbol bloat analysis (toolchain auto-resolve from build_info.json, #428)
  • sdkconfig.md - ESP sdkconfig user-override design (5-layer precedence chain, sdkconfig.fragment, fbuild.toml forward-compat — design proposal, not yet implemented)
  • update-check.md - Passive update check + install-source classification + opt-out flags (#626 Phase 1)
  • sync.md - fbuild sync command + platformio.lock schema + lib_deps source classification (#618 Phase 1)
  • 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) and fbuild deploy --to emu [--emulator <kind>]