docs/README.md
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.
showcase/shell-docs/src/content/
(docs/, reference/, snippets/, framework-overviews/).ag-ui-protocol/ag-ui (publishes to docs.ag-ui.com),
then sync back into the mirror at showcase/shell-docs/src/content/ag-ui/.See .claude/docs/documentation.md for the full rule.
This is a Next.js application generated with Create Fumadocs.
Run development server:
npm run dev
# or
pnpm dev
# or
yarn dev
Open 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:
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_DOCSPR previews:
.github/workflows/deploy_docs_vercel_preview.yml deploys docs previews for
non-fork pull requests.Open Docs Preview link.Recommended Vercel project setting: