docs: rework Introduction and Getting Started - #1278
Merged
Merged
Conversation
Falls back to the home page when there is no same-site entry to return to. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Introduction: - Position OpenUI as the open standard for Generative UI, with OpenUI Lang at its core - Replace the static demo image with a live OpenUI Lang streaming demo (Preview / OpenUI Lang toggle) - Add a "How it works" flow diagram showing Gateway (recommended) and direct calls with Autofix - Replace the stack cards with a "What's in OpenUI" list - Fold in "How OpenUI works" and remove that page (redirect /docs/architecture to /docs) Getting Started: - Single `openui create` command for new apps - End-to-end integration steps adapted from the Gateway quickstart, with Gateway and OpenAI + Autofix tabs - Next steps links Also adds a `hideFooter` frontmatter option to hide the previous/next page links. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…name Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ix example Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Adds an optimized looping video (1600px, 30fps, no audio, 2 MB) with a poster below the first paragraph, and removes the now-unused stream demo component. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
vishxrad
approved these changes
Sep 30, 2026
This branch was successfully deployed
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
New readers couldn't tell how OpenUI works from the Introduction, and Getting Started didn't walk through an integration. This reworks both pages.
Introduction (
/docs)OpenUILangStreamDemo): OpenUI Lang streams in and renders withopenuiLibrary, with a Preview / OpenUI Lang toggle and Replay. It starts when scrolled into view and respectsprefers-reduced-motion.OpenUIFlowDiagram, inline SVG, light/dark via theme tokens) showing both routes: through OpenUI Gateway (recommended) or calling models directly with Autofix. The steps are kept to one line each.architecture.mdx) since its content now lives in the Introduction./docs/architectureredirects to/docs, and the nav entry and test are updated.Getting Started
npx @openuidev/cli@latest createcommand, linking to the CLI reference for flags and deploy.generate-api-keycommand, and a note on using other providers.Other
hideFooterfrontmatter option (source.config.ts,docs-page.tsx) to hide the previous/next page links.This branch also carries an earlier commit, "make navbar back button go back in history when possible", plus a merge from main.
Test plan
lib/docs-navigation.test.tspasses/docsand/docs/getting-startedin the browser: demo streaming, toggle and Replay; diagram in light and dark; phone-width layout; Getting Started tabs🤖 Generated with Claude Code