mcpField
I
intelligence-docs

intelligence-docs

github.com/copilotkit開発38.3k779 回インストール今日更新
リポジトリ

intelligence-docs について

CopilotKit Intelligence のドキュメント運用 Skill です。新機能やドキュメントページを製品概要から見つけられるようにし、ナビゲーションとテストも同時に更新します。

主な機能

  1. 01概要ページから Intelligence ページへリンク
  2. 02サイドバーとセクションナビを更新
  3. 03機能カードとランディングリンクを追加
  4. 04ランディングページ変更に合わせてテストを更新
  5. 05ページの追加・移動・削除に対応

活用シーン

  1. 01Intelligence 新機能のガイドを公開
  2. 02ドキュメントページをナビゲーションと概要に追加
  3. 03Intelligence ページを移動または改名
  4. 04機能やページの終了時にリンクを整理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/copilotkit/copilotkit --skill intelligence-docs

インストール後、Claude Code で/intelligence-docsを入力して読み込まれたか確認します。

詳細

Intelligence ランディングページ

/intelligence/overview は CopilotKit Intelligence の製品ランディングページです。 新しい Intelligence 機能や新しい Intelligence ドキュメントページは、同じ変更でこの ページに掲載する必要があります。ランディングページに記載されていないガイドを 公開してはいけません。

使用するタイミング

以下の場合にこのスキルを読み込みます。

  • 新しい Intelligence 機能を公開するとき(スレッド、分析、学習、チャネル、 ホスティング、インスペクション、または後続の主要機能)
  • showcase/shell-docs/src/content/docs/intelligence/ の下にページを追加、 名前変更、または削除するとき
  • 共有 Intelligence 概要スニペットまたは機能カードを変更するとき

これらのページに顧客向けの文章を書く前に、 skills/intelligence-vocabulary/SKILL.md も必ず参照してください。

Intelligence を使用しないオープンソースのフロントエンドガイドや、 Inspector ペインのコールアウト(inspector-docs)では読み込まないでください。

ランディングページのソース

機能またはドキュメントページの変更と同時に、以下を編集します。

対象ファイル
ヒーローの CTA(CONNECT_HREF)とカードshowcase/shell-docs/src/components/content/landing-pages/intelligence-overview.tsx
本文、クイックスタートリンク、ホスティングリンクshowcase/shell-docs/src/content/snippets/shared/intelligence/overview.mdx
セクションナビゲーションshowcase/shell-docs/src/content/docs/intelligence/meta.json
ルートサイドバーの Intelligence グループshowcase/shell-docs/src/content/docs/meta.json
カードと CTA のテストshowcase/shell-docs/src/components/content/landing-pages/__tests__/intelligence-overview.test.tsx

ルートの概要ページはスニペットを読み込むだけです。 docs/intelligence/overview.mdx にランディングページのコピーを重複して記載しないでください。

手順

手順 1:機能またはドキュメントページを追加する
  1. ガイドページを docs/intelligence/ の下に追加または更新します(機能がすでに使用している 既存のスレッド/チャネルのパスでも構いません)。
  2. サイドバーに表示するページの場合は、そのページを intelligence/meta.json と docs/meta.json の Intelligence グループに追加します。
  3. 共有スニペットからページにリンクします。ユーザー向けの主要機能には、 intelligence-overview.tsx の FEATURES に一意の CTA ラベルを持つカードを追加します。 ホスティングまたはアカウントのページは、Intelligence の実行場所を選択の下にリンクを 追加します。すべてのリンクは実在する URL にしてください。
  4. 同じページへのリンクを重複して追加しないでください。1 ページにつき、ランディングページの項目は 1 つです。
  5. 機能がヒーロー内で名前付きの主要機能として示されている場合は、サブタイトルにも追加します。
  6. 同じコミットでテストを拡張します。新しい CTA の href はリテラル値で固定してください。
手順 2:ページの名前を変更する、または移動する
  1. 古いパスを参照しているランディングページの CTA をすべて更新します。対象はカードの href、 クイックスタートリンク、およびIntelligence の実行場所を選択の下にあるリンクです。
  2. meta.json ファイルを更新します。
  3. それらの href を固定しているテストを更新します。
手順 3:機能またはページを削除する
  1. カードまたはスニペット内のリンク、サブタイトルの記載、ナビゲーション項目を削除します。
  2. 対応するテストのアサーションを削除します。
  3. 削除したページへのランディングリンクを残さないでください。

判断フロー

  • 新しい Intelligence 機能または新しい Intelligence ドキュメントページ:手順 1
  • 名前の変更または移動:手順 2
  • 削除:手順 3
  • ドキュメントは存在するが、ランディングページに記載されていない:作業を止めて手順 1 を実施

要注意事項

シグナル意味代わりに行うこと
ガイドをマージしたが、ランディングページは未更新読者が機能を見つけられません同じ PR で手順 1 を実施します
カードの href とスニペットのリンク先が異なる1 つの機能について説明が 2 つありますURL を 1 つに統一します
ドキュメントページがあるのに、CTA がマーケティングサイトを指しているランディングページからガイドに移動できませんドキュメントページを指すようにします
ヒーローのサブタイトルにカードのない柱が記載されているコピーに導線がありませんカードを追加するか、その記載を削除します

エラー処理

  • ドキュメントページがまだない場合: ガイドをでっち上げないでください。現在の公開プロダクト URL を指すスニペットリンクを追加し、ガイドの公開後に差し替えることはできます。
  • 機能が Intelligence 専用だが、docs/intelligence/ の外にある場合: ランディングページの CTA は追加してください。実際のパス(/threads、/channels など)を使用します。

コメント