Migrate docs site to package-based Geistdocs#537
Open
molebox wants to merge 1 commit into
Open
Conversation
Replace the vendored Geistdocs template in apps/website with the published @vercel/geistdocs package. The package now owns the shared runtime (layout, docs renderer, search, Ask AI chat, markdown routes, proxy, and MDX components) while the app keeps thin user-owned adapters. - Add @vercel/geistdocs 1.7.2 and bump Next.js to 16.2.6 (exact peer) - Delete ~50 vendored runtime files (components/geistdocs, hooks, custom chat UI, search/chat route implementations, feedback action) - Replace routes with package factories: createDocsPage, createChatRoute, createSearchRoute, createLlmsRoute, createDocsMarkdownRoute, createSitemapMarkdownRoute, createProxy - AI chat now uses the package-owned Ask AI (AI SDK v6 via the package) - Adopt the package geistdocs.css theme with @source entries for the geistdocs and streamdown dists; add a compat token layer in global.css for user-owned components - Add new /agents.md and /.well-known/mcp.json agent-readiness routes with Streamdown agent metadata in geistdocs.tsx - Keep the landing page, playground, KaTeX/Mermaid MDX pipeline, redirects, and workspace streamdown live demos intact - Prune dependencies now owned by the package (dexie, @orama/tokenizers, ai, @ai-sdk/react, etc.) and unused shadcn components
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
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
1 participant
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
Migrates
apps/websitefrom the vendored Geistdocs template to the new package-based architecture using@vercel/geistdocs1.7.2.The site was previously a copied-in instance of the old Geistdocs template (~50 vendored runtime files under
components/geistdocs/,hooks/geistdocs/, custom chat/search routes, etc.). The package now owns the shared runtime, and the app keeps thin user-owned adapters.What changed
Package-owned runtime
createDocsPage,createChatRoute,createSearchRoute,createLlmsRoute,createDocsMarkdownRoute,createSitemapMarkdownRoute, andcreateProxyai/@ai-sdk/reactdeps are removedcreateMdxComponents(Callout, Mermaid, TypeTable, CodeBlock, Video, etc. — everything the content uses)geistdocs.css(Geist DS tokens) with@sourceentries for both the geistdocs and streamdown dists, per the geistdocs styling requirementscomponents/geistdocs/*,hooks/geistdocs/*, chat/search implementations, feedback server action, and now-unused shadcn componentsNew for free
/agents.mdagent-readiness route with Streamdown product metadata/.well-known/mcp.jsonroute (404s by design until MCP servers are configured)apps/website/content/docs/{path})lastModifiedsupport in sitemap/RSS via the package source configPreserved
/playground(incl. Vega-Lite custom renderer)streamdown+@streamdown/*packagesremark-math/rehype-katexpassed intodefineGeistdocsSourceConfig)geistdocsFrontmatterSchema), redirects, OG images, RSSglobal.cssmaps the legacy shadcn theme tokens used by user-owned components onto Geist DS tokensDependency changes
@vercel/[email protected],next16.1.5 → 16.2.6 (exact peer requirement)ai,@ai-sdk/react,dexie,dexie-react-hooks,@orama/tokenizers,cmdk,vaul,mermaid,nanoid,next-themes,jotai,react-playerFuture upgrades use
npx @vercel/geistdocs update, which bumps the dependency without touching local adapter files.Testing
pnpm turbo build --filter=websitepasses (all 25 docs pages, llms.mdx pages, and OG images prerender)tsc --noEmitandpnpm check(ultracite) cleannext start:/,/docs,/docs/getting-started,/docs/plugins/mermaid,/playground→ 200/llms.txt,/sitemap.md,/agents.md,/rss.xml,/docs/getting-started.md→ 200 with correct markdown outputAccept: text/markdownnegotiation on/docs/usage→ 200/docs/mermaidredirect → 308Notes for reviewers