Boardflare Notebook Reference
The canonical developer and user reference for the Boardflare Python for Excel add-in and notebooks.
The Boardflare Notebook Reference is the single canonical documentation for the Python add-in and notebooks. It covers add-in setup, editing workbooks, marimo reactivity, the boardflare API, workbook design, testing, troubleshooting, limits, and the changelog.
Reference Sections
- Boardflare Notebook Reference: Overview: Architecture, execution model, and guidelines for AI assistants.
- The Boardflare Add-in: Add-in installation, task pane, Edit vs. App mode, and shared runtime cold start.
- Troubleshooting and FAQ: Common errors, root causes, and FAQ.
- Editing a Notebook Workbook: Code Sheet & AI Handshake: Hidden sheet layout, the AI edit loop, and the H1/H2 request-response handshake.
- Python Notebooks: Marimo, Reactivity, and Runtime: Marimo reactivity, variable rules, imports and dependencies, and Pyodide runtime constraints.
- The Boardflare Python API: Complete API reference for the boardflare (bf) package.
- Workbook Design: Inputs, Selections, and Outputs: Workbook inputs, table selections, and published outputs and functions.
- Testing and Verification: Testing, verification protocol, error inspection, and convergence checks.
- System Limits and Constraints: System limits, timeouts, and payload constraints.
- Boardflare Notebook Changelog: Release notes and API evolution.
Machine-Readable Reference
For AI assistants and automated tools:
- llms.txt: Index following the llmstxt.org specification.
- llms-full.txt: Complete documentation concatenated into a single file for copy-pasting into chat assistants.