CopilotKit documentation is now authored in showcase/shell-docs/.
This top-level docs/ Next app and its content/docs/ MDX tree no longer publish to the
live site. Changes made here will not reach docs.copilotkit.ai. The
showcase/scripts/sync-docs-from-main.ts script is legacy (one-direction, docs/ → shell-docs)
and should not be relied on.
- CopilotKit docs → author in
showcase/shell-docs/src/content/(docs/,reference/,snippets/,framework-overviews/). - AG-UI protocol docs → author upstream in
ag-ui-protocol/ag-ui(publishes to docs.ag-ui.com), then sync back into the mirror atshowcase/shell-docs/src/content/ag-ui/.
See .claude/docs/documentation.md for the full rule.
Legacy README (retained for history)
This is a Next.js application generated with Create Fumadocs.
Run development server:
npm run dev
# or
pnpm dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
To learn more about Next.js and Fumadocs, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- Fumadocs - learn about Fumadocs
Docs assets are tracked with Git LFS. To ensure production builds always receive
real asset bytes (not pointer files), deploy docs through GitHub Actions using
.github/workflows/deploy_docs_vercel.yml.
Required GitHub repository secrets:
VERCEL_TOKENVERCEL_ORG_IDVERCEL_PROJECT_ID_DOCS
PR previews:
.github/workflows/deploy_docs_vercel_preview.ymldeploys docs previews for non-fork pull requests.- The workflow posts/updates a sticky PR comment with a clickable
Open Docs Previewlink.
Recommended Vercel project setting:
- Disable automatic Git-based deployments for the docs project and let the GitHub Actions workflow handle production deploys.