inspector-docs

Inspector 文档标注

Inspector 是显示 Threads、Agents 和 Learning 的 localhost 叠加层。 读者可以使用的每个已发布面板都必须有一个文档指针。该 指针告诉读者打开 Inspector 并查看该面板。

何时使用

在以下情况加载此技能：

• 在 Inspector 中添加、重命名或移除了面板、标签页或叠加层操作
• 文档页面介绍了一项 Inspector 已展示的功能
• 一个 PR 同时涉及 Inspector 源代码和产品文档

不要为图标、ping、布局或仅文案的 Inspector 更改加载它，因为这些 更改不添加面板。那些 UI 更改使用 inspector-workbench。

如果同一更改还编辑了 Inspector UI，则也加载 inspector-workbench 并启动独立实验室。

流程

流程 1：将已发布面板映射到文档

1. 使用读者在 Inspector 中看到的标签命名已发布面板。
2. 如果映射面板，请在继续之前阅读 references/pane-map.md。
3. 如果面板未发布，停止。不要添加标注。
4. 如果映射中已有页面，打开该页面并确认标注命名了此面板以及成功的样子。
5. 如果映射中没有页面，在匹配的共享根文档页面上添加标注，或在映射中写 no page yet。不要虚构页面。
6. 在同一更改中更新 references/pane-map.md。

流程 2：移除面板

1. 如果移除面板，请在继续之前阅读 references/pane-map.md。
2. 从映射页面移除标注。
3. 删除映射行。

流程 3：快速入门健全性检查步骤

默认 Web 快速入门在首次聊天后包含一个编号步骤：

1. Agents 然后 Agent：该 agent 已列出。
2. 发送聊天消息。Agents 然后 AG-UI Events：事件正在移动。
3. Threads：已解锁，或使用 Enable Intelligence 锁定。

Angular 像其他每个 Web 前端一样使用共享步骤片段：@copilotkit/angular 自动挂载固定的 @copilotkit/web-inspector，因此没有可链接的安装步骤（OSS-948）。React Native 和 Channels 完全不会获得此步骤。

决策树

• Inspector 面板添加、重命名或更改：
  • 如果面板未发布：停止
  • 否则：流程 1
• Inspector 面板移除：流程 2
• 快速入门或首次运行文档：流程 3
  • 如果面板也是新的：流程 1

危险信号

信号	含义	改为执行
标注命名 Playground、Fork、emit events 或其他未发布想法	文档会宣传叠加层中不存在的工作	停止。在 references/pane-map.md 中的 Unshipped 下记录该想法
在 React Native 或 Channels 上“点击 Inspector 按钮”	那些界面没有 Web 叠加层	跳过 Open Inspector 步骤
标注命名了叠加层不显示的面板	该指针是谎言	将标注重写为已发布面板，或移除它

错误处理

• 面板未发布：停止。不要为 Playground、Fork、emit events 或其他未发布工作添加标注。
• 没有匹配的文档页面：在映射中记录 no page yet。除非用户要求，不要创建新的文档部分。
• 非 Web 界面（React Native、Channels）：不要添加“点击 Inspector 按钮”。
• 标注命名了叠加层不显示的面板：重写标注或移除它。