-
Notifications
You must be signed in to change notification settings - Fork 4
docs(*): update-ai-assited-dev-npm-redme #160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 4 commits
74067cf
1704859
5c055b2
766cf07
73be40a
52f5c80
ee62cf9
3de3730
93d321a
2598967
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,14 +62,64 @@ 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 | | ||
|
radomirchev marked this conversation as resolved.
Outdated
|
||
| | **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 | | ||
|
radomirchev marked this conversation as resolved.
Outdated
|
||
|
|
||
| > **Note:** All AI toolchain commands require Ignite UI CLI 16.0.0 or newer. | ||
|
radomirchev marked this conversation as resolved.
Outdated
radomirchev marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Add AI toolchain to an existing project | ||
|
|
||
| Run this command from the root of your project: | ||
|
|
||
| ```bash | ||
| ig ai-config | ||
| ``` | ||
|
|
||
| This copies Agent Skills into the agent discovery path and writes MCP server entries to `.vscode/mcp.json`. | ||
|
|
||
| ### 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`. | ||
|
radomirchev marked this conversation as resolved.
Outdated
radomirchev marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I liked the original description paragraph we use across repos better, the "developer-owned instruction packages" says a lot of words, but can't tell what it means TBH.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. subjective
radomirchev marked this conversation as resolved.
Outdated
|
||
|
|
||
| | 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. | ||
|
radomirchev marked this conversation as resolved.
|
||
|
|
||
| ### 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. | ||
|
radomirchev marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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 | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.