API Reference
RDoc reference for the public OpenUI Rails classes and methods.
The generated API reference opens on the OpenUI module. It is generated from the source comments.
| If you need to… | Start with |
|---|---|
| Configure the engine and integrations | OpenUI::Rails::Configuration |
| Render a mount or model a surface | ViewHelper, Surface |
| Build a prompt and validate its manifest | PromptBuilder, LibraryManifest |
| Normalize a stream | Stream::Bridge, Stream::Envelope |
| Deliver stream frames | Stream::Broadcaster, Stream::Transports |
| Register and dispatch actions | Actions::Registry, Actions::Dispatcher |
| Use the RubyLLM adapter | Adapters::RubyLLM |
For Markdown, open the API class index. Every HTML class page has a matching .md page.
Build the reference locally with docs/bin/build-api.sh tmp/api.