feat: improve OpenUI Gateway integration guidance - #14
Merged
Merged
Conversation
vishxrad
changed the title
vishxrad
changed the title
vishxrad
changed the title
zahlekhan
reviewed
Sep 9, 2026
Comment on lines
+63
to
+72
| ## Design for Model Reliability | ||
|
|
||
| - Use descriptive, distinct component names and descriptions that explain when to choose each component. | ||
| - Keep schemas flat. Prefer several composable components over deeply nested objects. | ||
| - Compose children through component `.ref` schemas. Use `z.union([...])` only when the container genuinely accepts several child types. | ||
| - Order Zod object keys deliberately: required and distinctive props first, optional props last. OpenUI Lang maps positional arguments using this order. | ||
| - Keep the library focused on components the model should generate. Do not expose an entire product design system by default. | ||
| - Choose a predictable root that can render before its referenced children arrive, then keep `root = ...` first in generated examples for progressive streaming. | ||
| - Use `componentGroups` and short group `notes` when they materially help the model choose related components or avoid an invalid combination. | ||
| - Use `tagSchemaId()` for reusable non-component helper schemas when the generated signature would otherwise degrade to `any`. |
Contributor
There was a problem hiding this comment.
ask aditya to review this section
zahlekhan
approved these changes
Sep 9, 2026
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
2 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.
Summary
openui-cloudCLI template, while preserving explicit self-hosted requirements and existing application architecture.references/gateway/, with separate Responses, Chat Completions, Conversations, and standalone artifact runbooks. Preserve Chat Completions history/tool loops and all three Responses history modes.conversationplusstore: truefor new persistent Gateway chats, while preserving existing history ownership. Link directly to both protocols' app-owned tool loops.Validation
quick_validate.py skills/openui: passed.git diff --check: passed.thesysdev/openui@a47bb1934c5185a8abc482760c9563ee1511a331.@openuidev/cli@0.2.12,@openuidev/thesys@0.3.2, and@openuidev/thesys-server@0.1.4without executing package install scripts.No new Claude behavior evaluation, authenticated Gateway generation, or standalone artifact endpoint test was run. The skill explicitly distinguishes verified template/package contracts from documentation gaps.
Context
OpenUI Cloud launch work item: https://thesys-dev.slack.com/archives/C0783MULUMQ/p1787898666168549