inspector-docs

Обновление документации CopilotKit Inspector

CopilotKit/CopilotKitАвторский скилл
37 927звёзд4 720форковУ всего репозитория

Что получите

Документация с актуальными подсказками о выпущенных разделах Inspector и обновлённым соответствием разделов страницам.

Что передать

Изменённый раздел Inspector, связанные страницы документации и платформа приложения.

Автопроверка файлов

Проверен состав файлов. Запуск не тестировался. Что проверено

Оценки пользователей

Загрузка оценок…
Ваш опыт
Обсудить →

Как использовать

Помогает разработчикам и авторам документации CopilotKit поддерживать подсказки о доступных разделах Inspector. При добавлении, переименовании или удалении раздела документация должна направлять читателя к реальному интерфейсу.

  1. Назовите раздел так, как он отображается пользователю, и подтвердите, что он уже выпущен.
  2. Обновите подсказку на связанной странице или удалите её вместе с исчезнувшим разделом.
  3. Если меняется инструкция первого запуска веб-приложения, добавьте проверку агента, событий и доступности потоков в Inspector.

Условия работы

  • Подсказки добавляются только для выпущенных разделов; новую страницу или раздел документации нельзя придумывать без запроса пользователя.
  • React Native и Channels не имеют веб-оверлея Inspector и не получают шаг его открытия.
  • Если одновременно меняется интерфейс Inspector, обязателен скилл `inspector-workbench` и запуск отдельного стенда.

Пример запроса после установки

Обнови документацию после переименования выпущенной вкладки Inspector: используй новую подпись, проверь связанную страницу и сохрани согласованность инструкции первого запуска веб-приложения CopilotKit.

Пример составлен по инструкции автора; результат запуска не проверялся.

Основание: инструкция закреплённой версии

Для установки

Node.js, npm и Git для команды выше. Подключения и инструменты для работы скилла настраиваются отдельно.

Совместимые агенты

Совместимость указана для инструкций. Запуск в каждом приложении не тестировался; для веб-чата способ подключения может отличаться.

Файлы скилла

GitHub
Читать инструкцию SKILL.md

Исходный текст закреплённой версии.

---
name: inspector-docs
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.
version: 1.0.1
---

# 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.

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 yet` in 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.

Проверка и особенности

Автоматическая проверка источника и файлов

Автоматически сверены публичный репозиторий, лицензия, YAML-заголовок SKILL.md, состав папки и Git-хеш каждого файла. Исполняемые файлы и срабатывания статических правил исключены из этой партии. Ручной аудит всех инструкций и проверка работы не проводились; эта проверка не гарантирует безопасность. Команда закреплена на проверенном коммите.

Интерес к репозиторию оцениваем по звёздам и форкам GitHub. Это показатели всего репозитория, а не числа установок отдельного скилла.

Проверка состава
16.09.2026
Проверенная версия
a140d1d4eb0c
Файлы с кодом
Не указаны в данных проверки
Изменения на GitHub
Нужна повторная проверкаПоследняя проверка: 11.10.2026
Как мы проверяем скиллы

Репозиторий и лицензия

CopilotKit/CopilotKit
37 927 звёзд4 720 форков

Это показатели всего репозитория, а не установки скилла. Снимок требует обновления.

Последняя активность GitHub
10.10.2026
Лицензия
MIT
Добавлен в каталог
16.09.2026
Полный текст лицензии
The MIT License

Copyright (c) Atai Barkai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Ещё в этой категории

Все в категории

Обсуждение

Правила

Пользовались этим скиллом? Делитесь опытом без регистрации. Все комментарии проверяет модератор.

Мои комментарии