The Open Standard for Generative UI
Docs optimization for llms (#362)
Rabi Shanker Guhadaad1bc11286
diff --git a/.github/workflows/context7.yml b/.github/workflows/context7.ymlnew file mode 100644index 000000000..6776087ce--- /dev/null+++ b/.github/workflows/context7.yml@@ -0,0 +1,20 @@+name: Refresh Context7 docs++on:+ schedule:+ - cron: "0 6 * * *"+ workflow_dispatch:++jobs:+ refresh:+ runs-on: ubuntu-latest+ steps:+ - uses: rennf93/[email protected]+ with:+ operation: refresh++ - name: Show result+ run: |+ echo "Success: ${{ steps.refresh.outputs.success }}"+ echo "Status: ${{ steps.refresh.outputs.status-code }}"+ echo "Message: ${{ steps.refresh.outputs.message }}"diff --git a/docs/app/docs/[[...slug]]/page.tsx b/docs/app/docs/[[...slug]]/page.tsxindex 77b887bb9..8d5c34f60 100644--- a/docs/app/docs/[[...slug]]/page.tsx+++ b/docs/app/docs/[[...slug]]/page.tsx@@ -22,7 +22,7 @@ export default async function Page(props: PageProps<"/docs/[[...slug]]">) {<LLMCopyButton markdownUrl={`${page.url}.mdx`} /><ViewOptionsmarkdownUrl={`${page.url}.mdx`}- githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/content/docs/${page.path}`}+ githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/docs/content/docs/${page.path}`}/></div><DocsBody>diff --git a/docs/components/docs-route-layout.tsx b/docs/components/docs-route-layout.tsxindex 4c86eae35..e2269a913 100644--- a/docs/components/docs-route-layout.tsx+++ b/docs/components/docs-route-layout.tsx@@ -3,6 +3,7 @@import { DocsNavbar } from "@/components/docs-navbar";import { baseOptions, siteConfig } from "@/lib/layout.shared";import { DocsLayout } from "fumadocs-ui/layouts/docs";+import { Play, Plug } from "lucide-react";import Link from "next/link";import type { ReactNode } from "react";@@ -53,18 +54,7 @@ export function DocsRouteLayout({ tree, children }: DocsRouteLayoutProps) {href="/playground"label="Playground"external- icon={- <svg- viewBox="0 0 24 24"- fill="none"- stroke="currentColor"- strokeWidth="2"- strokeLinecap="round"- strokeLinejoin="round"- >- <polygon points="5 3 19 12 5 21 5 3" />- </svg>- }+ icon={<Play />}/><SidebarBannerLinkhref={siteConfig.discordUrl}@@ -76,6 +66,11 @@ export function DocsRouteLayout({ tree, children }: DocsRouteLayoutProps) {</svg>}/>+ <SidebarBannerLink+ href="/docs/mcp"+ label="Docs MCP"+ icon={<Plug />}+ /></div>),}}diff --git a/docs/content/docs/mcp/index.mdx b/docs/content/docs/mcp/index.mdxindex 605e58518..7de8eb9ab 100644--- a/docs/content/docs/mcp/index.mdx+++ b/docs/content/docs/mcp/index.mdx@@ -1,8 +1,35 @@----title: MCP Server-description: Docs MCP Server — coming soon.+title: Documentation MCP Server+description: Connect OpenUI documentation to your AI coding tools via MCP.----## Coming Soon+## MCP Server-The Docs MCP Server is under construction. Check back soon.+OpenUI docs are available through [Context7](https://context7.com), which provides a Model Context Protocol (MCP) server that AI coding tools can query directly.++Add `use context7` to any prompt, or reference the library explicitly:++```+use library /thesysdev/openui+```++## Quick setup++The fastest way to get started — authenticates via OAuth, generates an API key, and installs the appropriate skill:++```bash+npx ctx7 setup+```++Use `--cursor`, `--claude`, or `--opencode` to target a specific agent.++## Manual setup++For manual installation instructions for 30+ clients (Cursor, VS Code, Claude Desktop, Windsurf, ChatGPT, Lovable, Replit, JetBrains, and more), see the [Context7 MCP Clients](https://context7.com/docs/resources/all-clients) page.++## LLM-friendly docs++For tools that support `llms.txt`, or if you want to load docs directly into context:++- [`/llms.txt`](/llms.txt) — index of all doc pages+- [`/llms-full.txt`](/llms-full.txt) — full documentation in a single file