Skip to content

docs: add OpenUI integration guide - #127

Open
AbhinRustagi wants to merge 1 commit into
starc007:mainfrom
AbhinRustagi:feat/openui-guide
Open

docs: add OpenUI integration guide#127
AbhinRustagi wants to merge 1 commit into
starc007:mainfrom
AbhinRustagi:feat/openui-guide

Conversation

@AbhinRustagi

@AbhinRustagi AbhinRustagi commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Closes #117

Summary

  • Adds a new docs page (app/docs/openui/page.tsx) walking through registering beUI components as an OpenUI library, so a generative UI runtime can render model output with real, animated beUI components (install, defineComponent/createLibrary usage, and a Renderer example).
  • Wires the new page into app/sitemap.ts, site search, and the sidebar nav.

Test plan

  • bun run typecheck
  • bun run lint
  • Visit /docs/openui locally and confirm the page renders, code blocks are correct, and sidebar/search links resolve

@starc007

Copy link
Copy Markdown
Owner

Thanks for adding this guide — the direction looks useful. A few changes before merging:

  • Show beuiLibrary.prompt() being generated and passed to the model; otherwise the documented flow only renders OpenUI Lang but doesn’t explain how to produce it.
  • Wire BeButton with useTriggerAction and show Renderer’s onAction; currently generated buttons are inert.
  • Replace z.array(z.any()) with a union of the registered component .ref schemas so Stack children are properly described and validated.
  • Revert the unrelated bun.lock change since no dependencies changed.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Integration Guides with OpenUI & other Generative UI frameworks

2 participants