diff --git a/.azure-pipelines/artifacts/README_Components.md b/.azure-pipelines/artifacts/README_Components.md index 2c1df61..403e7c3 100644 --- a/.azure-pipelines/artifacts/README_Components.md +++ b/.azure-pipelines/artifacts/README_Components.md @@ -62,14 +62,66 @@ This package provides the following components: | Tree | ✅ | [Docs](https://www.infragistics.com/products/ignite-ui-react/react/components/grids/tree) | ## AI-Assisted Development - -This package ships with **LLM Agent Skills** — structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, JetBrains AI, etc.) how to work with Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory: - + +Ignite UI for React provides a complete AI toolchain — **Agent Skills**, the **Ignite UI CLI MCP server**, the **Ignite UI Theming MCP server**, and the **MAKER MCP server** — that grounds AI coding assistants in correct component APIs, import paths, and design tokens. + +| Component | What it provides | Requires Ignite UI installed? | +|:----------|:----------------|:-----------------------------:| +| **Agent Skills** | Developer-owned instruction packages: import paths, component patterns, decision flows, project conventions | Yes | +| **CLI MCP server** (`igniteui-cli`) | Documentation queries, API reference, project scaffolding tools via MCP | No | +| **Theming MCP server** (`igniteui-theming`) | Design tokens, palette tools, CSS custom property generation, WCAG AA contrast validation | No | +| **MAKER MCP server** (`@igniteui/maker-mcp`) | Multi-agent orchestration: decomposes complex tasks into validated, executable step plans | No | + +> **Note:** All AI toolchain commands require Ignite UI CLI 16.0.0 or newer. + +You can start evaluating Ignite UI AI assistance with the MCP servers alone — Ignite UI does not need to be installed in your project. Agent Skills become available once you install Ignite UI packages. + +### Add AI toolchain to an existing project + +Run this command from the root of your project: + +```bash +npx igniteui-cli ai-config +``` + +This copies Agent Skills into the agent discovery path and writes MCP server entries to `.vscode/mcp.json`. After the command finishes, start the MCP servers in your AI client — they are configured but not yet running. + +### Start a new project with AI toolchain + +Run the Ignite UI CLI to scaffold a new React project with the AI toolchain configured from the start: + +```bash +ig new +``` + +The CLI prompts for project name and theme, installs dependencies, and configures Agent Skills and MCP servers in a single interactive flow. If the CLI is not installed globally, use `npm install -g igniteui-cli`. + +### Agent Skills + +This package ships with **Agent Skills** — structured, developer-owned instruction packages that tell AI coding assistants exactly how to use Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory. + | Skill | Description | |:------|:------------| | **components** | Identify the right React components (`Igr*`) for a UI pattern, then install, import, and use them — JSX patterns, events, refs, forms, Next.js setup | | **customize-theme** | Customize styling using CSS custom properties, Sass, and the theming system in React | | **optimize-bundle-size** | Reduce bundle size with granular imports, tree-shaking, and lazy loading | + +When a Skill is active in the AI client, the agent follows the Skill instead of relying on general training data — which may reference outdated API signatures or import paths. The Skill package is developer-owned: edit the `SKILL.md` to match your team's conventions, add project-specific patterns, and version the package alongside your codebase. + +### Supported AI Clients + +| Client | Configuration method | +|:-------|:--------------------| +| VS Code with GitHub Copilot | `.vscode/mcp.json` | +| Cursor | `.cursor/mcp.json` | +| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` | +| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` | +| Claude Code | `.mcp.json` or the Claude Code MCP CLI command | +| JetBrains AI Assistant | **Tools → AI Assistant → Model Context Protocol (MCP)** | + +Agent Skills are compatible with GitHub Copilot via `.github/copilot-instructions.md`, Cursor via `.cursorrules` or `.cursor/rules/`, Windsurf via `.windsurfrules`, and JetBrains AI Assistant via project-level prompt settings. + +For full setup instructions, see the [AI-Assisted Development documentation](https://www.infragistics.com/products/ignite-ui-react/react/components/ai-assisted-development-overview). ## License diff --git a/.azure-pipelines/artifacts/README_DockManager.md b/.azure-pipelines/artifacts/README_DockManager.md index 331b3da..ff8a501 100644 --- a/.azure-pipelines/artifacts/README_DockManager.md +++ b/.azure-pipelines/artifacts/README_DockManager.md @@ -30,14 +30,66 @@ Provide a complete windowing experience, splitting complex layouts into smaller, - Fully customizable appearance and behavior ## AI-Assisted Development - -This package ships with **LLM Agent Skills** — structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, JetBrains AI, etc.) how to work with Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory: - + +Ignite UI for React provides a complete AI toolchain — **Agent Skills**, the **Ignite UI CLI MCP server**, the **Ignite UI Theming MCP server**, and the **MAKER MCP server** — that grounds AI coding assistants in correct component APIs, import paths, and design tokens. + +| Component | What it provides | Requires Ignite UI installed? | +|:----------|:----------------|:-----------------------------:| +| **Agent Skills** | Developer-owned instruction packages: import paths, component patterns, decision flows, project conventions | Yes | +| **CLI MCP server** (`igniteui-cli`) | Documentation queries, API reference, project scaffolding tools via MCP | No | +| **Theming MCP server** (`igniteui-theming`) | Design tokens, palette tools, CSS custom property generation, WCAG AA contrast validation | No | +| **MAKER MCP server** (`@igniteui/maker-mcp`) | Multi-agent orchestration: decomposes complex tasks into validated, executable step plans | No | + +> **Note:** All AI toolchain commands require Ignite UI CLI 16.0.0 or newer. + +You can start evaluating Ignite UI AI assistance with the MCP servers alone — Ignite UI does not need to be installed in your project. Agent Skills become available once you install Ignite UI packages. + +### Add AI toolchain to an existing project + +Run this command from the root of your project: + +```bash +npx igniteui-cli ai-config +``` + +This copies Agent Skills into the agent discovery path and writes MCP server entries to `.vscode/mcp.json`. After the command finishes, start the MCP servers in your AI client — they are configured but not yet running. + +### Start a new project with AI toolchain + +Run the Ignite UI CLI to scaffold a new React project with the AI toolchain configured from the start: + +```bash +ig new +``` + +The CLI prompts for project name and theme, installs dependencies, and configures Agent Skills and MCP servers in a single interactive flow. If the CLI is not installed globally, use `npm install -g igniteui-cli`. + +### Agent Skills + +This package ships with **Agent Skills** — structured, developer-owned instruction packages that tell AI coding assistants exactly how to use Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory. + | Skill | Description | |:------|:------------| | **components** | Identify the right React components (`Igr*`) for a UI pattern, then install, import, and use them — JSX patterns, events, refs, forms, Next.js setup | | **customize-theme** | Customize styling using CSS custom properties, Sass, and the theming system in React | | **optimize-bundle-size** | Reduce bundle size with granular imports, tree-shaking, and lazy loading | + +When a Skill is active in the AI client, the agent follows the Skill instead of relying on general training data — which may reference outdated API signatures or import paths. The Skill package is developer-owned: edit the `SKILL.md` to match your team's conventions, add project-specific patterns, and version the package alongside your codebase. + +### Supported AI Clients + +| Client | Configuration method | +|:-------|:--------------------| +| VS Code with GitHub Copilot | `.vscode/mcp.json` | +| Cursor | `.cursor/mcp.json` | +| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` | +| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` | +| Claude Code | `.mcp.json` or the Claude Code MCP CLI command | +| JetBrains AI Assistant | **Tools → AI Assistant → Model Context Protocol (MCP)** | + +Agent Skills are compatible with GitHub Copilot via `.github/copilot-instructions.md`, Cursor via `.cursorrules` or `.cursor/rules/`, Windsurf via `.windsurfrules`, and JetBrains AI Assistant via project-level prompt settings. + +For full setup instructions, see the [AI-Assisted Development documentation](https://www.infragistics.com/products/ignite-ui-react/react/components/ai-assisted-development-overview). ## License diff --git a/.azure-pipelines/artifacts/README_Grids.md b/.azure-pipelines/artifacts/README_Grids.md index d60ff4c..5b040e0 100644 --- a/.azure-pipelines/artifacts/README_Grids.md +++ b/.azure-pipelines/artifacts/README_Grids.md @@ -69,7 +69,7 @@ Run the Ignite UI CLI to scaffold a new React project with the AI toolchain conf ig new ``` -The CLI prompts for project name and theme, installs dependencies, and configures Agent Skills and MCP servers in a single interactive flow. If the CLI is not installed globally, use `npx igniteui-cli@latest new`. +The CLI prompts for project name and theme, installs dependencies, and configures Agent Skills and MCP servers in a single interactive flow. If the CLI is not installed globally, use `npm install -g igniteui-cli`. ### Agent Skills