mcpField
I
intelligence-docs

intelligence-docs

github.com/copilotkitDevelopment38.3k779 installsUpdated today
Repository

About intelligence-docs

A documentation workflow skill for CopilotKit Intelligence. It ensures new Intelligence features and documentation pages are discoverable from the product overview, with corresponding navigation and tests updated alongside them.

Key features

  1. 01Links Intelligence pages from the overview
  2. 02Updates sidebar and section navigation
  3. 03Adds feature cards and landing links
  4. 04Updates tests for landing-page changes
  5. 05Handles page additions, moves, and removals

Use cases

  1. 01Publish a guide for a new Intelligence feature
  2. 02Add a documentation page to navigation and landing
  3. 03Move or rename an Intelligence page
  4. 04Remove links when a feature or page is retired

Install

Copy the command and run it in a terminal.

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

After installing, type/intelligence-docsin Claude Code to confirm it loaded.

Details

From the project README

Intelligence Landing Page

/intelligence/overview is the product landing for CopilotKit Intelligence. New Intelligence features and new Intelligence docs pages must land on that page in the same change. Do not ship a guide that the landing does not name.

When To Use

Load this skill when:

  • A new Intelligence feature ships (threads, analytics, learning, channels, hosting, inspection, or a later pillar)
  • A page is added, renamed, or removed under showcase/shell-docs/src/content/docs/intelligence/
  • The shared Intelligence overview snippet or feature cards change

Before writing customer-facing words on those pages, also follow skills/intelligence-vocabulary/SKILL.md.

Do not load it for open-source frontend guides that do not use Intelligence, or for Inspector pane callouts (inspector-docs).

Landing sources

Edit these in the same change as the feature or docs page:

SurfaceFile
Hero CTA (CONNECT_HREF) and cardsshowcase/shell-docs/src/components/content/landing-pages/intelligence-overview.tsx
Body, quickstart link, hosting linksshowcase/shell-docs/src/content/snippets/shared/intelligence/overview.mdx
Section navshowcase/shell-docs/src/content/docs/intelligence/meta.json
Root sidebar Intelligence groupshowcase/shell-docs/src/content/docs/meta.json
Card and CTA testsshowcase/shell-docs/src/components/content/landing-pages/__tests__/intelligence-overview.test.tsx

The root overview page only wraps the snippet. Do not duplicate landing copy in docs/intelligence/overview.mdx.

Procedures

Procedure 1: Add a feature or docs page
  1. Add or update the guide page under docs/intelligence/ (or the existing threads/channels path the feature already uses).
  2. Put the page in intelligence/meta.json and in the Intelligence group in docs/meta.json when it belongs in the sidebar.
  3. Link the page from the shared snippet. A user-facing pillar gets a card in FEATURES in intelligence-overview.tsx with a unique CTA label. A hosting or account page gets a link under Choose where Intelligence runs. Every link must be a real URL.
  4. Do not add a second link for the same page. One page, one landing entry.
  5. If the feature is a named pillar in the hero, add it to the subtitle.
  6. Extend the tests in the same commit. Pin the new CTA href as a literal.
Procedure 2: Rename or move a page
  1. Update every landing CTA that pointed at the old path: card href, quickstart link, and the links under Choose where Intelligence runs.
  2. Update meta.json files.
  3. Update the tests that pin those hrefs.
Procedure 3: Remove a feature or page
  1. Remove the card or snippet link, subtitle mention, and nav entry.
  2. Remove the matching test assertions.
  3. Do not leave a landing link to a deleted page.

Decision Tree

  • New Intelligence feature or new Intelligence docs page: Procedure 1
  • Rename or move: Procedure 2
  • Remove: Procedure 3
  • Docs exist but landing does not name them: stop and run Procedure 1

Red Flags

SignalWhat it meansDo instead
Guide merged, landing unchangedReaders cannot find the featureProcedure 1 in the same PR
Card href and snippet link differTwo stories for one featureUse one URL
CTA points at the marketing site when a docs page existsLanding skips the guidePoint at the docs page
Hero subtitle lists a pillar with no cardCopy without a pathAdd the card, or drop the mention

Error Handling

  • No docs page yet: do not invent a guide. You can still add a snippet link that points at the current public product URL, and replace it when the guide ships.
  • Feature is Intelligence-only but lives outside docs/intelligence/: still add the landing CTA. Use the real path (/threads, /channels, and similar).

Comments

Markdown supported