Skip to content

Commit 62c5489

Browse files
BenTaylorDevclaude
andcommitted
Merge origin/main into codex/ent-734-pydantic-ai
Conflict resolutions: - page.tsx: keep the threads layout; swap the dead v1 sidebar labels (title/initial) for the v2 keys (modalHeaderTitle 'Popup Assistant' + welcomeMessageText) the starter smoke asserts, and carry over main's disableSystemMessage + clickOutsideToClose. Keep her useRenderTool render({ parameters }) — that is the actual v2 RenderToolProps shape; main's render({ args }) was a latent runtime bug (args is not a prop). - package.json: keep the drawer UI deps (class-variance-authority, clsx). - integration test: fold into the parameterized batch-2 contract test; migratedIntegrations now crewai-flows + llamaindex + pydantic-ai (18/18). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2 parents d5aaf6e + f3ec5dd commit 62c5489

107 files changed

Lines changed: 44485 additions & 1143 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.agents/skills/showcase-demo-debugging/SKILL.md

Lines changed: 0 additions & 192 deletions
This file was deleted.

.agents/skills/showcase-demo-debugging/agents/openai.yaml

Lines changed: 0 additions & 4 deletions
This file was deleted.

.claude/docs/documentation.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Documentation — where to author it
2+
3+
There are **two** documentation domains. Putting a change in the wrong place means it
4+
silently never reaches the live site. Read this before editing any docs.
5+
6+
## 1. CopilotKit product docs → `showcase/shell-docs/`
7+
8+
All CopilotKit documentation is authored in **`showcase/shell-docs/src/content/`**, which
9+
builds and serves **docs.copilotkit.ai**:
10+
11+
| Content type | Location |
12+
| ------------------------------ | ------------------------------------------------------ |
13+
| Guide / how-to / concept pages | `showcase/shell-docs/src/content/docs/` |
14+
| API reference | `showcase/shell-docs/src/content/reference/` |
15+
| Reusable snippets (shared MDX) | `showcase/shell-docs/src/content/snippets/` |
16+
| Framework overview pages | `showcase/shell-docs/src/content/framework-overviews/` |
17+
18+
When you add a **guide page** under `docs/`, also update that section's `meta.json` so it
19+
appears in navigation.
20+
21+
**API reference is different.** The v2 reference (`reference/{components,hooks,sdk}/`) has
22+
**no `meta.json`** — navigation is generated automatically by walking the tree and reading
23+
each page's `title`/`description` frontmatter (see
24+
`showcase/shell-docs/src/lib/reference-items.ts`). To add a reference page, drop an `.mdx`
25+
file with frontmatter into the right subdirectory; it appears in nav on its own. Only the
26+
legacy `reference/v1/` tree uses `meta.json`. For the full new-hook checklist see
27+
[Hook Development](hooks.md).
28+
29+
**The top-level `docs/` folder is retired. Never author there.**
30+
`docs/content/docs/` and the `docs/` Next app no longer publish anything. The
31+
`showcase/scripts/sync-docs-from-main.ts` script is legacy — it only ever copied
32+
`docs/` → shell-docs in one direction, and editing `docs/` today does nothing for the
33+
live site. Treat the whole top-level `docs/` tree as read-only history.
34+
35+
## 2. AG-UI protocol docs → upstream `ag-ui-protocol/ag-ui`
36+
37+
The AG-UI protocol docs (the `showcase/shell-docs/src/content/ag-ui/` tree) are **not**
38+
authored in this repo. Their canonical source is the upstream repo
39+
**[`ag-ui-protocol/ag-ui`](https://github.com/ag-ui-protocol/ag-ui)** under its `docs/`
40+
directory, which publishes to **docs.ag-ui.com**.
41+
42+
The `content/ag-ui/` copy here is a **downstream mirror** rendered on the CopilotKit docs
43+
host. To change AG-UI protocol docs, make the change upstream in `ag-ui-protocol/ag-ui`;
44+
it then needs to be synced back into the CopilotKit copy.
45+
46+
> **Do not author AG-UI content changes directly in `content/ag-ui/`** — they would diverge
47+
> from upstream and never reach docs.ag-ui.com.
48+
49+
**Caveat (known, out of scope here):** there is currently no automated sync for the
50+
`content/ag-ui/` mirror, so it can drift from upstream. Upstream is canonical — don't try to
51+
change that process as part of unrelated work.
52+
53+
## Quick decision
54+
55+
- Changing a CopilotKit guide, reference, snippet, or framework page? → `showcase/shell-docs/src/content/`
56+
- Changing AG-UI protocol docs? → upstream `ag-ui-protocol/ag-ui`, then sync
57+
- Tempted to edit `docs/content/docs/`? → stop, it's retired; use `showcase/shell-docs/`

.claude/docs/hooks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@ When creating a new hook, always complete **all** of the following:
55
1. **Implementation**: Create the hook in `@copilotkit/react-core`. If backward compatibility shims are needed, add them in the package's `v1/` directory.
66
2. **JSDoc**: Add JSDoc on top of the hook implementation, including usage examples.
77
3. **Tests**: Write extensive tests covering behavior, edge cases, and lifecycle (mount/unmount/re-render).
8-
4. **Documentation**: Add a dedicated docs page under `/docs` and update the relevant docs metadata file(s) so the page appears in navigation.
8+
4. **API reference**: Add a reference page at `showcase/shell-docs/src/content/reference/hooks/<hookName>.mdx` with `title` and `description` frontmatter. The v2 reference navigation is generated automatically by walking the `reference/` tree and reading frontmatter (see `showcase/shell-docs/src/lib/reference-items.ts`) — there is **no `meta.json`** to edit for v2 reference; the file and its frontmatter are the metadata. (Only the legacy `reference/v1/` tree uses `meta.json`.)
9+
5. **Conceptual docs (if needed)**: If the hook needs usage/how-to documentation beyond the API reference, add a guide page under `showcase/shell-docs/src/content/docs/` and update that section's `meta.json` so it appears in navigation.
10+
11+
Never author docs in the retired top-level `docs/` folder. See [Documentation](documentation.md).

0 commit comments

Comments
 (0)