# Inspector Docs

Keeps CopilotKit docs pointing at shipped Inspector panes so readers open the overlay.

- Repository: https://github.com/CopilotKit/CopilotKit (38452 stars)
- Category: Design
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add CopilotKit/CopilotKit --skill inspector-docs -g -a claude-code -y`
Codex: `npx skills add CopilotKit/CopilotKit --skill inspector-docs -g -a codex -y`
Cursor: `npx skills add CopilotKit/CopilotKit --skill inspector-docs -g -a cursor -y`
Gemini CLI: `npx skills add CopilotKit/CopilotKit --skill inspector-docs -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add CopilotKit/CopilotKit`

## Description

Keeps CopilotKit docs pointing at shipped Inspector panes so readers open the overlay. Use when adding, changing, renaming, or removing an Inspector pane, tab, or overlay action in @copilotkit/web-inspector, or when editing docs that mention Inspector. Don't use for Inspector UI polish that does not add a pane, for CLI or agent-prompt copy, or for unshipped Inspector ideas.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Inspector Docs Callouts

Inspector is the localhost overlay that shows Threads, Agents, and Learning.
Every shipped pane that a reader can use must have a docs pointer. The
pointer tells the reader to open Inspector and look at that pane.

## When To Use

Load this skill when:

- A pane, tab, or overlay action is added, renamed, or removed in Inspector
- A docs page teaches a feature that Inspector already shows
- A PR touches both Inspector source and product docs

Do not load it for icon, ping, layout, or copy-only Inspector changes that
do not add a pane. Those UI changes use `inspector-workbench`.

If the same change also edits Inspector UI, load `inspector-workbench` as
well and start the standalone lab.

## Procedures

### Procedure 1: Map a shipped pane to docs

1. Name the shipped pane using the label the reader sees in Inspector.
2. If mapping a pane, read `references/pane-map.md` before proceeding.
3. If the pane is not shipped, stop. Do not add a Callout.
4. If the map already has a page, open that page and confirm the Callout names this pane and what success looks like.
5. If the map has no page, add a Callout on the matching shared root docs page, or write `no page yet` in the map. Do not invent a page.
6. Update `references/pane-map.md` in the same change.

### Procedure 2: Remove a pane

1. If removing a pane, read `references/pane-map.md` before proceeding.
2. Remove the Callout from the mapped page.
3. Delete the map row.

### Procedure 3: Quickstart sanity-check step

The default web quickstart includes a numbered step after the first chat:

1. **Agents** then **Agent**: the agent is listed.
2. Send a chat message. **Agents** then **AG-UI Events**: events are moving.
3. **Threads**: unlocked, or locked with Enable Intelligence.

The rest: https://github.com/CopilotKit/CopilotKit/blob/HEAD/skills/inspector-docs/SKILL.md