docs: restructure Burr UI documentation into dedicated section (#411)#815
Merged
Conversation
* Adds docs/ui.rst as a top-level 'Burr UI' entry in the Sphinx sidebar, mirroring how Hamilton surfaces their UI * Covers quickstart, data model, notebook/Colab usage, FastAPI embedding, and See Also links to the tracking reference and monitoring deployment guides
…sue 411 * docs: restructure Burr UI documentation into dedicated section (apache#411) Add a dedicated docs/ui/ section covering the Burr UI from installation through notebook usage and production deployment, with focused pages for getting-started, notebook/Colab, and deployment.
t1mato
changed the title
elijahbenizzy
approved these changes
Jun 22, 2026
elijahbenizzy
left a comment
elijahbenizzy
left a comment
Contributor
There was a problem hiding this comment.
This looks good, thanks!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #411
Add a dedicated
docs/ui/section covering the Burr UI from installation through notebook usage and production deployment, with focused pages for getting-started, notebook/Colab, and deployment. Updatedocs/index.rstto point to the newui/indextoctree entry and remove the previous single-pageui.rst.