docs: add migration guide from json-render (Fixes #354) - #1124
docs: add migration guide from json-render (Fixes #354)#1124SparshMishra09 wants to merge 1 commit into
Conversation
Adds a focused documentation page for teams moving from json-render (vercel-labs/json-render) to OpenUI Lang. The guide explains the concept mapping between the two systems, walks through converting the catalog/spec/renderer to OpenUI's component library, and covers system prompts, state, expressions, actions, and streaming. The new page is registered under the Advanced section of the OpenUI Lang documentation. Fixes thesysdev#354
|
@SparshMishra09 is attempting to deploy a commit to the thesys-devs Team on Vercel. A member of the Team first needs to authorize it. |
|
Hi maintainers — quick heads-up that this PR is currently merge-blocked by the Vercel preview deploy check, not by anything in the diff itself. The Vercel bot is asking a member of the thesys-devs team to authorize the GitHub integration so the deploy job can run: Could someone with access to the Vercel team please approve the integration so the docs preview can build? Once that is done I am happy to address any review feedback, and the rest of the PR (Closes #354 — json-render migration guide under docs/content/docs/openui-lang/) is ready to go. Thanks! |
|
Hi maintainers — small follow-up on the merge blockers, in case it helps triage. There are currently two independent maintainer-side actions keeping this PR from being merged, not one:
Either of those is enough to clear the merge-blocker on its own; both need to be addressed before the Vercel preview can build and the red X can turn green. No code changes are needed from my side. The diff (Closes #354 — json-render migration guide under Thanks again! |
Summary
Adds a new documentation page that helps users move from
json-render(vercel-labs/json-render) to OpenUI Lang. The page is wired into the OpenUI Lang docs under theAdvancedsection viadocs/content/docs/openui-lang/meta.json.Closes #354.
Contents
json-renderto OpenUI LangdefineCatalogtodefineComponent+createLibraryspec/elementsto OpenUI Lang statements and referencescatalog.prompt()with@openuidev/cli generate+generateSystemPrompt<Renderer spec registry />with<Renderer library response />///to `` and expressionsAction,onAction, and@ToAssistantQuery,Mutation, andtoolProvidercreateSpecStreamCompilerto OpenUI's streaming-friendly parserFiles
docs/content/docs/openui-lang/migration-from-json-render.mdx(new, 400 lines)docs/content/docs/openui-lang/meta.json(registered the new page underAdvanced)Validation
Notes
Advancedsection proposed by maintainers in issue Migration guide from json-render #354.