inspector-docs
Skill0 starsChanged 2 months agoMITView on GitHub
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.
1 other project uses a version of this.
Adopted by
Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Most recently taken up by
- CopilotKit/CopilotKitword for word, first seen Oct 8, 2026
Other versions1 project uses a version of this.
Word for word · 1
- CopilotKit/CopilotKit★ 39k100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository21 other files it gives its agents.
- .claude/CLAUDE.mdCLAUDE.md
- angular-developerSkill
- channels-setupSkill
- copilotkit-channelsSkill
- copilotkit-cliSkill
- copilotkitSkill
- csharp-asyncSkill
- csharp-docsSkill
- csharp-xunitSkill
- ef-coreSkill
- github-actions-efficiencySkill
- github-actions-hardeningSkill
- github-actions-runtime-upgrade-conventionsSkill
- inspector-workbenchSkill
- intelligence-docsSkill
- microsoft-agent-frameworkSkill
- microsoft-docsSkill
- ngrx-signal-storeSkill
- prdSkill
- setup-slack-channelSkill
- technical-writingSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
13 rules. About 0 are common, 7 are distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 16
Every shipped pane that a reader can use must have a docs pointer.
- Very specific: line 27
Do not load it for icon, ping, layout, or copy-only Inspector changes that do not add a pane.
- Very specific: line 30
If the same change also edits Inspector UI, load inspector-workbench as well and start the standalone lab.
- Very specific: line 38
If mapping a pane, read references/pane-map.md before proceeding.
- Distinctive: line 39
If the pane is not shipped, stop.
- Distinctive: line 40
If the map already has a page, open that page and confirm the Callout names this pane and what success looks like.
- Very specific: line 41
If the map has no page, add a Callout on the matching shared root docs page, or write no page yet in the map.
- Very specific: line 42
Update references/pane-map.md in the same change.
- Very specific: line 46
If removing a pane, read references/pane-map.md before proceeding.
- Distinctive: line 47
Remove the Callout from the mapped page.
- Distinctive: line 48
Delete the map row.
- Distinctive: line 63
If the pane is not shipped: stop
- Distinctive: line 67
If a pane is also new: Procedure 1
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
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
- Name the shipped pane using the label the reader sees in Inspector.
- If mapping a pane, read
references/pane-map.mdbefore proceeding. - If the pane is not shipped, stop. Do not add a Callout.
- If the map already has a page, open that page and confirm the Callout names this pane and what success looks like.
- If the map has no page, add a Callout on the matching shared root docs page, or write
no page yetin the map. Do not invent a page. - Update
references/pane-map.mdin the same change.
Procedure 2: Remove a pane
- If removing a pane, read
references/pane-map.mdbefore proceeding. - Remove the Callout from the mapped page.
- Delete the map row.
Procedure 3: Quickstart sanity-check step
The default web quickstart includes a numbered step after the first chat:
- Agents then Agent: the agent is listed.
- Send a chat message. Agents then AG-UI Events: events are moving.
- Threads: unlocked, or locked with Enable Intelligence.
Angular uses the shared step snippet, like every other web frontend: @copilotkit/angular auto-mounts a pinned @copilotkit/web-inspector, so there is no install step to link (OSS-948). React Native and Channels do not get this step at all.
Decision Tree
- Inspector pane added, renamed, or changed:
- If the pane is not shipped: stop
- Else: Procedure 1
- Inspector pane removed: Procedure 2
- Quickstart or first-run docs: Procedure 3
- If a pane is also new: Procedure 1
Red Flags
| Signal | What it means | Do instead |
| Callout names Playground, Fork, emit events, or another unshipped idea | Docs would advertise work that is not in the overlay | Stop. Record the idea under Unshipped in references/pane-map.md |
| "Click the Inspector button" on React Native or Channels | Those surfaces have no web overlay | Skip the Open Inspector step |
| Callout names a pane the overlay does not show | The pointer is a lie | Rewrite the Callout to a shipped pane, or remove it |
Error Handling
- Pane is not shipped: halt. Do not add a Callout for Playground, Fork, emit events, or other unshipped work.
- No matching docs page: record
no page yetin the map. Do not create a new docs section unless the user asked for one. - Non-web surface (React Native, Channels): do not add "click the Inspector button".
- Callout names a pane the overlay does not show: rewrite the Callout or remove it.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.