Skip to content

docs: add dedicated Burr UI server documentation (issue #272)#810

Open
enu-emu wants to merge 2 commits into
apache:mainfrom
enu-emu:docs/burr-ui-server
Open

docs: add dedicated Burr UI server documentation (issue #272)#810
enu-emu wants to merge 2 commits into
apache:mainfrom
enu-emu:docs/burr-ui-server

Conversation

@enu-emu

@enu-emu enu-emu commented Jun 18, 2026

Copy link
Copy Markdown

Summary

Closes #272

  • Creates docs/concepts/ui.rst with a full guide to the Burr UI server: installation, CLI options (with examples), demo data walkthrough, step-by-step descriptions of every UI feature, notebook/Colab launch, FastAPI embedding, and how to wire up tracking so your app appears in the UI
  • Registers the new page in docs/concepts/index.rst under the Concepts toctree, positioned after tracking

What's in the new page

  • Installationpip install "apache-burr[start]" with a note on the Python 3.13 / pandas compatibility fix
  • Demo Data and First Launch — explains the four auto-copied demo projects so new users can explore immediately
  • Command-Line Options — list-table covering --port, --host, --no-open, --no-copy-demo_data, --backend, and --dev-mode with usage examples
  • What You Can Do — seven subsections (Browse Projects, Explore Demos, Inspect Steps, Compare State, View Source, Replay a Run, Watch Live) each with a "Try it:" instruction using the built-in demo data
  • Launch from a Notebook%burr_ui magic with Google Colab instructions
  • Embed in FastAPImount_burr_ui example
  • Making Your App Appear.with_tracker() setup with a cross-reference to tracking

Testing

  • make html in docs/ — Sphinx build passes, zero new warnings from the new files
  • New page appears in the Concepts navigation in the built HTML output
  • All CLI flags verified against burr --help
  • All UI features verified manually using the bundled demo projects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation on how to run the Burr UI server

1 participant