Back to Details

inspector-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Inspector Docs Callouts

Inspector文档标注

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.
Inspector是本地环境中的覆盖层，用于展示Threads、Agents和Learning模块。每个可供读者使用的已发布面板都必须在文档中设置指向链接，引导读者打开Inspector并查看该面板。

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.
在以下场景中应用此规则：
  • 在Inspector中添加、重命名或移除面板、标签页或覆盖层操作
  • 文档页面介绍Inspector已支持的功能
  • 代码变更（PR）同时涉及Inspector源码和产品文档
请勿将其用于仅修改图标、提示、布局或文案但未添加新面板的Inspector变更。

Procedures

操作流程

Procedure 1: Map a shipped pane to docs

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

  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.
  1. 使用读者在Inspector中看到的标签来命名已发布面板。
  2. 若要映射面板，请先阅读
    references/pane-map.md
    再继续操作。
  3. 若面板未发布，请停止操作，不要添加标注。
  4. 若映射表中已有对应页面，请打开该页面并确认标注中正确命名了此面板以及成功状态的描述。
  5. 若映射表中没有对应页面，请在匹配的共享根文档页面添加标注，或在映射表中填写
    no page yet
    ，请勿自行创建新页面。
  6. 在同一变更中更新
    references/pane-map.md
    。

Procedure 2: Remove a pane

流程2：移除面板

  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.
  1. 若要移除面板，请先阅读
    references/pane-map.md
    再继续操作。
  2. 从映射页面中移除对应标注。
  3. 删除映射表中的对应行。

Procedure 3: Quickstart sanity-check step

流程3：快速入门 sanity-check 步骤

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 Angular step snippet, which links the Angular Inspector install page first. React Native and Channels do not get this step.
默认的Web快速入门教程在首次聊天后包含以下编号步骤：
  1. 点击Agents，然后选择Agent：查看已列出的Agent。
  2. 发送一条聊天消息。点击Agents，然后选择AG-UI Events：查看事件动态。
  3. 点击Threads：查看解锁状态，或在启用智能功能后查看锁定状态。
Angular使用Angular步骤片段，该片段会先链接到Angular Inspector安装页面。React Native和Channels不包含此步骤。

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
  • Inspector面板被添加、重命名或修改：
    • 若面板未发布：停止操作
    • 否则：执行流程1
  • Inspector面板被移除：执行流程2
  • 快速入门或首次运行文档：执行流程3
    • 若同时有新面板：执行流程1

Red Flags

警示信号

SignalWhat it meansDo instead
Callout names Playground, Fork, emit events, or another unshipped ideaDocs would advertise work that is not in the overlayStop. Record the idea under Unshipped in 
references/pane-map.md
"Click the Inspector button" on React Native or ChannelsThose surfaces have no web overlaySkip the Open Inspector step
Callout names a pane the overlay does not showThe pointer is a lieRewrite the Callout to a shipped pane, or remove it
信号含义正确做法
标注中提及Playground、Fork、emit events或其他未发布的创意文档会宣传尚未在覆盖层中实现的功能停止操作，将该创意记录在
references/pane-map.md
的“未发布”部分
React Native或Channels文档中出现“点击Inspector按钮”的描述这些平台没有Web覆盖层跳过“打开Inspector”步骤
标注中提及的面板未在覆盖层中显示指向链接不符合实际情况将标注改写为指向已发布的面板，或移除该标注

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.
  • 面板未发布：终止操作。请勿为Playground、Fork、emit events或其他未发布功能添加标注。
  • 无匹配文档页面：在映射表中记录
    no page yet
    。除非用户要求，否则请勿创建新的文档章节。
  • 非Web平台（React Native、Channels）：请勿添加“点击Inspector按钮”的描述。
  • 标注提及未显示的面板：改写标注或移除该标注。