Skills

Inspector Docs

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

Install

npx skills add CopilotKit/CopilotKit --skill inspector-docs -g -a claude-code -y
Repository
CopilotKit/CopilotKit38.5k
Category
Design
Updated
3d ago
License
MIT
Context cost
Lightabout 927 tokens
Runs scripts
No, instructions only

What it does

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.

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.
Read the whole SKILL.md on GitHub

More in Design