Documentation: genui components catalog + prompting guide
Maintainers usually reply within 1 day
@pr3khar is already working on this.
Since May 19, 2026.
Assessment
This issue has not been assessed yet.
Description
Context
OpenUI exposes a generative UI components library, but we don't currently document it. Users have no easy way to discover what components are available or how to prompt the LLM to render a specific one, which is blocking wider adoption of the genui layer.
Scope
The goal is a dedicated docs section (or page on the docs site) covering the genui components library end-to-end.
Must have
- Component catalog — every exposed component listed with: short description, supported props/variants, and a screenshot or live preview.
- Prompting guide — recommended patterns and keywords for steering the LLM toward a specific component or layout. Call out anything the system is explicitly tuned for.
- Example gallery — handful of end-to-end examples showing prompt → rendered output across common patterns (forms, dashboards, comparisons, lists, etc.).
- Extension guide — how contributors can add a new component to the library so the LLM can pick it.
- Dominant language
- TypeScript
- Stars
- 10k
- Forks
- 698
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 133
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from thesysdev/openui
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
thesysdev/openui#1445 · 2 comments ·
Maintainers usually reply within 1 day
-
Add dataInvention flag to PromptOptions to disable the 'generate realistic/plausible data' ruleOpen
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
thesysdev/openui#959 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 18/100
thesysdev/openui#1528 · 1 reaction ·
Maintainers usually reply within 1 day
All issues in thesysdev/openui
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
pingdotgg/t3code#30228 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
ci-cd desktop size:low telemetry-improvement telemetry-round-1
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
vfarcic/dot-agent-deck#2079 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 83/100
Maintainers usually reply within 1 day