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：クイックスタートの整合性確認ステップ

デフォルトのウェブ版クイックスタートには、最初のチャットの後に番号付きステップが含まれます。

1. Agents、次に Agent：エージェントが一覧に表示されます。
2. チャットメッセージを送信します。Agents、次に AG-UI Events：イベントが流れています。
3. Threads：ロックが解除されているか、Enable Intelligence でロックされています。

Angular は、他のすべてのウェブフロントエンドと同様に共有ステップのスニペットを使用します。@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 ボタンをクリック」と記されている	これらの環境にはウェブオーバーレイがありません	Open Inspector のステップを省略します
オーバーレイに表示されないペインがコールアウトに記されている	案内が事実に反しています	コールアウトをリリース済みのペインに合わせて書き直すか、削除します

エラー処理

• ペインがリリースされていない：中止します。Playground、Fork、emit events、またはその他の未リリース機能についてコールアウトを追加しないでください。
• 該当するドキュメントページがない：マップに no page yet と記録します。ユーザーから依頼されていない限り、新しいドキュメントセクションを作成しないでください。
• ウェブ以外の環境（React Native、Channels）：「Inspector ボタンをクリック」を追加しないでください。
• オーバーレイに表示されないペインがコールアウトに記されている：コールアウトを書き直すか、削除します。