copilotkit__copilotkit

mirror of https://github.com/CopilotKit/CopilotKit.git synced 2026-09-14 16:26:20 +08:00

Files

T

History

Austin Merrick 14bfd3bf83 docs(shell-docs): reference documentation for @copilotkit/core (#5154 )

Adds reference documentation for **`@copilotkit/core`** and turns the
reference landing into a multi-SDK **Overview**.

## What changed
- **3-way SDK picker** — React v2 / React v1 / **Core (TypeScript)**
(was a v1/v2 toggle).
- **"API Reference" → "Overview"**, with a "Choose your SDK" chooser.
- **12 hand-written core reference pages** — index, 2 classes, 6 types,
3 enums — matching the existing v2 React convention, every
signature/default/behavior verified against `@copilotkit/core` source.
- **Fixed reference code-block rendering** — the reference route was
missing syntax highlighting + the styled code block (bare `<pre>`); now
wired to the same pipeline as the main docs. Improves all reference SDKs
(v1/v2/core).

## Screenshots
**Overview + "Choose your SDK"**

<img width="1512" height="805" alt="overview"
src="https://github.com/user-attachments/assets/478d6839-4a21-4ba7-917e-5f8b2b74ea12"
/>


**3-way SDK picker**

<img width="1512" height="805" alt="picker"
src="https://github.com/user-attachments/assets/43a094d4-1f62-476b-82f2-d293714471f0"
/>

**Core reference page (syntax-highlighted code + copy button)**

<img width="1512" height="805" alt="core-page"
src="https://github.com/user-attachments/assets/92b661a9-5859-4719-8a39-aa9ade739950"
/>


## Why hand-written (not auto-generated)
The generator can't extract enums/type-aliases (which dominate core's
surface) and overwrites hand-edits; the existing v2 React docs are
themselves hand-written. The ticket explicitly allows deferring
auto-gen.

2026-06-04 08:50:09 -07:00