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. 01发布 Intelligence 新功能指南
  2. 02将文档页面加入导航和概览
  3. 03迁移或重命名 Intelligence 页面
  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 功能发布(threads、analytics、learning、channels、 hosting、inspection,或后续的支柱功能)
  • 在 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/ 下添加或更新指南页面(或该功能已使用的现有 threads/channels 路径)。
  2. 当页面属于侧边栏时,将其加入 intelligence/meta.json,并加入 docs/meta.json 中的 Intelligence 分组。
  3. 从共享片段链接到该页面。面向用户的支柱功能在 intelligence-overview.tsx 的 FEATURES 中获得一张卡片,并带有唯一的 CTA 标签。 托管或账户页面则在 Choose where Intelligence runs 下获得一个链接。每个链接都必须是真实 URL。
  4. 不要为同一页面添加第二个链接。一个页面,一个落地页条目。
  5. 如果该功能是首屏中点名的支柱功能,请将其添加到副标题中。
  6. 在同一次提交中扩展测试。将新的 CTA href 作为字面量进行固定。
流程 2:重命名或移动页面
  1. 更新所有指向旧路径的落地页 CTA:卡片的 href、 快速开始链接,以及 Choose where Intelligence runs 下的链接。
  2. 更新 meta.json 文件。
  3. 更新固定这些 href 的测试。
流程 3:移除功能或页面
  1. 移除卡片或片段链接、副标题中的提及,以及导航条目。
  2. 移除对应的测试断言。
  3. 不要留下指向已删除页面的落地页链接。

决策树

  • 新的 Intelligence 功能或新的 Intelligence 文档页面:流程 1
  • 重命名或移动:流程 2
  • 移除:流程 3
  • 文档存在但落地页未提及:停下来,执行流程 1

危险信号

信号含义应改为
指南已合并,落地页未变读者无法找到该功能在同一 PR 中执行流程 1
卡片 href 与片段链接不一致同一功能出现两种说法使用同一个 URL
已有文档页面时 CTA 却指向营销网站落地页跳过了指南指向文档页面
首屏副标题列出了某个支柱但没有对应卡片有文案却无路径添加该卡片,或删除该提及

错误处理

  • 尚无文档页面: 不要凭空编写指南。你仍然可以添加一个片段 链接,指向当前公开的产品 URL,并在 指南发布后替换它。
  • 功能仅属于 Intelligence,但位于 docs/intelligence/ 之外: 仍然要添加落地页 CTA。使用真实路径(/threads、/channels 及 类似路径)。

评论

支持 Markdown