Tyler Slaton
4093ab6289
## What Adds a **LangSmith Platform** deploy guide to the CopilotKit docs, modeled after the existing AWS AgentCore deploy page. It's a self-contained, agent-side guide: deploy a **LangGraph** or **Google ADK** agent to the LangSmith Platform, then point the CopilotKit Runtime at it. LangSmith has no frontend-hosting offering, so the guide covers only the agent side plus wiring the runtime. ## Pages - **Canonical:** `deploy/langsmith.mdx` — renders in the Overview → Deploy sidebar. - **Per-framework wrappers** (thin, like AgentCore): - `integrations/langgraph/deploy-langsmith.mdx` → `<Content framework="langgraph" .../>` - `integrations/adk/deploy-langsmith.mdx` → `<Content framework="adk" .../>` - Both registered in their `meta.json` under a new `---Deploy---` section. - **Shared walkthrough snippet:** `snippets/integrations/langsmith/index.mdx` — single source of truth for all three pages; framework-aware via the `Content` loader scope. Reuses the existing `langgraph-platform-deployment-tabs` snippet for the "grab your deployment URL" step. ## Structure (mirrors agentcore.mdx) Intro → How it works (ASCII flow `Browser → CopilotKit Runtime → LangSmith deployment → your agent`) → What you get → Quickstart `<Steps>` inside a `<TailoredContent>` (deploy-new vs already-deployed) → `<Callout>`s for the API key/URL and the LangSmith docs authority → framework tabs (LangGraph / Google ADK) for the deployable-app step → Troubleshooting `<Accordions>` → What's next `<Cards>`. ## Registry glue - Generalized the `Content` MDX component to accept an optional `partial` prop (defaults to the AgentCore partial; existing AgentCore wrappers unchanged). - Registered a `LangGraphPlatformDeploymentTabs` stub so the existing deployment-tabs snippet is reusable. ## Verification - Commands/flags (`uv tool install langgraph-cli`, `langgraph new --template new-langgraph-project-python`, `langgraph deploy --name/--deployment-type dedicated`, deployment API URL) verified against the live LangChain quickstart. - ADK path (`pip install "deployments-wrap-sdk[google-adk]"`, `saf_sdk.adk` `wrap()` + `LangsmithSessionService`, `langgraph.json` export) verified against the live [Deploy Google ADK agents](https://docs.langchain.com/langsmith/deploy-google-adk) guide. - Runtime wiring (`LangGraphAgent` from `@copilotkit/runtime/langgraph` with `deploymentUrl` / `graphId` / `langsmithApiKey`) matches the repo's LangGraph quickstart. - `oxfmt` (format) clean, `oxlint` exits 0, `tsc` clean; registry / search-href / link-rewrite tests pass. (Pre-existing failures in this worktree from an uninstalled `react-icons` and unfetched git-LFS assets are unrelated.) ## Note (small extra) The LangGraph `deploy-agentcore.mdx` wrapper already existed but was orphaned (not in any `meta.json`). The new `---Deploy---` section surfaces it alongside `deploy-langsmith`, matching how AWS Strands already exposes it. Ticket: GROW-540
Shell Docs
showcase/shell-docs is the Next.js app that builds and serves
docs.copilotkit.ai. Author CopilotKit product documentation here, not in the retired
top-level docs/ app.
Run Locally
Shell-docs is a standalone npm-based app. You do not need a root install just to run the docs app locally.
cd showcase/scripts
npm install
cd ../shell-docs
npm install
npm run dev
The local dev server runs on port 3003.
http://localhost:3003
The shell-docs npm lifecycle generates registry, demo-content, setup-content, and search
data before dev, build, and typecheck.
Validate Changes
Run these from showcase/shell-docs:
npm run build
npm run typecheck
npm run test
For repo-level CI parity, prefer Nx when a shell-docs target is available in the current checkout and root dependencies are installed. For normal shell-docs local development, the npm commands above are the canonical path.
Authoring Recipes
Showcase-Driven Framework Docs
Showcase-driven frameworks use docs_mode: generated. The docs are assembled from showcase
registry/generated data, demos, source regions, shared/root MDX, snippets, and sparse
framework overrides.
To update showcase-driven docs:
- Edit the showcase source of truth: manifests, demos, feature coverage, source regions, or registry inputs.
- Edit shared/root MDX only when the change applies across generated frameworks.
- Add sparse framework overrides only for real framework-specific differences.
- Do not hand-edit generated files under
src/data/frameworks/. - Validate routes, sidebar state, search results, snippets, and framework switching.
Authored Framework Docs
Authored frameworks use docs_mode: authored. The framework owns an MDX tree under
src/content/docs/integrations/<docsFolder>/ with a meta.json sidebar.
To update authored docs:
- Check
getDocsFolder()insrc/lib/registry.ts; the URL slug and folder name may differ. - Edit the MDX page under
src/content/docs/integrations/<docsFolder>/. - Update that folder's
meta.jsonwhen adding, removing, or moving pages. - Reuse shared snippets from
src/content/snippets/when content should stay consistent across frameworks. - Validate the framework route, sidebar, search result, and any shared snippet render.
Reference Docs
Edit API reference pages under src/content/reference/.
The v2 reference does not use meta.json; navigation is generated by walking the tree and
reading each page's title and description frontmatter. Only the legacy reference/v1/
tree uses meta.json.
Snippets
Reusable snippets live under src/content/snippets/. Snippets may be rendered by root docs,
authored framework pages, and showcase-driven framework pages, so keep them general unless
the path is intentionally framework-specific.
Frontend Applicability
Frontend routes use page-level applicability metadata, independent from where the content is authored. A page can be authored MDX, showcase-generated content, mirrored protocol docs, or reference content and still be universal across frontends.
Use the frontend field in page frontmatter or meta.json when a root doc should appear in
non-React frontend docs:
universal— render the same page under/<frontend>/....frontend-variant— render only when a matching page exists undersrc/content/docs/frontends/<frontend>/....hide— omit the page from frontend-scoped docs.
Do not use "showcase-driven" as a proxy for frontend availability. Showcase derivation is an authoring/source detail; frontend applicability controls routing and sidebar inclusion.
AG-UI Mirrored Docs
AG-UI protocol docs are authored upstream in ag-ui-protocol/ag-ui. The
src/content/ag-ui/ tree is a downstream mirror rendered on the CopilotKit docs host.
Change AG-UI docs upstream first, then sync the mirror back into shell-docs.
Top-Level Docs Symlink
The repository's top-level docs/ path is a symlink to showcase/shell-docs/ for
contributor muscle memory. It is not a separate docs app. Do not recreate the old
docs/content/docs/ tree; author CopilotKit docs in showcase/shell-docs/src/content/.