docs

docs/

Developer documentation for the BXP monorepo.

New here? Read in this order

1. devel.md — repo layout, build, test suite, design philosophy.
2. architecture.md — visual data-flow diagrams (skim).
3. gui.md — only if you're touching Flutter.
4. Module-level CLAUDE.md files — deepest reference, one per module (bxp-cli/CLAUDE.md, bxp-core/CLAUDE.md, bxp-fmt/CLAUDE.md, bxp-gui/CLAUDE.md, bxp-gui-bridge/CLAUDE.md, bxp-gui/packages/json5_ast/CLAUDE.md). Loaded automatically by Claude Code, read directly when you need internal-API detail.

End-user documentation (bundled with releases, not for new devs):

• resources/console/readme.md — bxp-cli user guide (config syntax, expression reference, broker list)
• resources/desktop/readme.md — bxp-gui user guide (installation, first run, update process)

---

File	Contents
devel.md	Start here. VS Code setup, clone + build, test suite, architecture narrative, how to add templates and built-in functions, release overview.
architecture.md	Mermaid diagrams: bird's-eye view, bxp-cli execution + pipeline + pre_pass + expression evaluator, bxp-gui layers + dry-run flow + config AST + expr playground, data structures.
gui.md	bxp-gui Flutter app: source layout, subprocess wiring, json5_ast AST library, TraceStore state management, dev-run workflow, key patterns.
release.md	Full release operator guide: what GH Actions builds, local smoke tests, verifying a published release, troubleshooting, signing status.
roadmap.md	Forward-looking milestones by version. Shipped items move to CHANGELOG.md.
trace-protokol.md	Full subprocess protocol reference: bxp-cli --trace NDJSON event stream + all bxp-fmt subcommand output formats (--expr, --expr-trace, --config, --docs).