Skip to content

Commit c034123

Browse files
fix(docs): update documentation to prefer component key in get_example calls
1 parent ec2da5f commit c034123

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

skills/igniteui-angular-components/references/data-display.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Types for linear bar: `'default'`, `'info'`, `'success'`, `'warning'`, `'error'`
251251

252252
## Chat (AI Chat Component)
253253

254-
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "chat" })` covers messages, attachments, quick replies, typing indicators, templates, and styling. Use `get_example({ framework: "angular", name: "chat" })` for working code samples. Prefer both over writing chat code from memory.
254+
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "chat" })` covers messages, attachments, quick replies, typing indicators, templates, and styling. Use `get_example({ framework: "angular", component: "chat" })` for working code samples. Prefer both over writing chat code from memory.
255255
256256
```typescript
257257
import { IgxChatComponent, IgxChatMessageContextDirective, type IgxChatOptions } from 'igniteui-angular/chat';

skills/igniteui-angular-components/references/directives.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Inputs: `[igxRipple]` (ripple color), `[igxRippleCentered]` (always start from c
8787

8888
## Tooltip
8989

90-
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "tooltip" })` covers triggers, overlay behavior, sticky/arrowed tooltips, styling, and accessibility. Use `get_example({ framework: "angular", name: "tooltip" })` for working code samples.
90+
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "tooltip" })` covers triggers, overlay behavior, sticky/arrowed tooltips, styling, and accessibility. Use `get_example({ framework: "angular", component: "tooltip" })` for working code samples.
9191
9292
The at-a-glance pairing — `igxTooltipTarget` on the host references the `igxTooltip` element (both from `igniteui-angular/directives`):
9393

skills/igniteui-angular-components/references/form-controls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Types: `line` (default), `border`, `box`, `search`.
4040

4141
## Combo (Multi-Select Dropdown)
4242

43-
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "combo" })` covers data binding, selection APIs, forms support, keyboard behavior, and known issues. Use `get_example({ framework: "angular", name: "combo" })` for working code samples. Prefer both over this snippet when available.
43+
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "combo" })` covers data binding, selection APIs, forms support, keyboard behavior, and known issues. Use `get_example({ framework: "angular", component: "combo" })` for working code samples. Prefer both over this snippet when available.
4444
4545
```typescript
4646
import { IgxComboComponent } from 'igniteui-angular/combo';
@@ -52,7 +52,7 @@ import { IgxComboComponent } from 'igniteui-angular/combo';
5252

5353
## Simple Combo (Single-Select)
5454

55-
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "simple-combo" })`. Use `get_example({ framework: "angular", name: "simple-combo" })` for working code samples.
55+
> **Full doc in the MCP:** `get_doc({ framework: "angular", name: "simple-combo" })`. Use `get_example({ framework: "angular", component: "simple-combo" })` for working code samples.
5656
5757
`IgxSimpleComboComponent` from `igniteui-angular/simple-combo` (its own entry point, not `/combo`). Same API as `igx-combo` but restricted to single selection.
5858

skills/igniteui-angular-figma-to-app/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ Each row gives you:
382382
Call `list_components({ framework: "angular" })` **once** to discover which component
383383
families have full docs — **the catalog covers only a subset of components**. Then:
384384

385-
- For families **with** a doc: call `get_example({ framework: "angular", name: "<doc-name>" })` (or `get_doc` when explanation context matters), all in a single parallel batch — never sequentially.
385+
- For families **with** a doc: call `get_example({ framework: "angular", component: "<doc-name>" })` (or `get_doc` when explanation context matters), all in a single parallel batch — never sequentially.
386386
- For families **without** a doc: read the matching reference files from the
387387
[`igniteui-angular-components`](../igniteui-angular-components/SKILL.md) and
388388
[`igniteui-angular-grids`](../igniteui-angular-grids/SKILL.md) skills, and use

skills/igniteui-angular-generate-from-image-design/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ For component-to-Ignite-UI mapping, see [references/component-mapping.md](refere
9494

9595
## Step 4: Look Up Component API
9696

97-
For every chosen component category that appears in the `list_components` results, call `get_example` with its doc `name` field (not the result title) — or `get_doc` when explanation context matters. **The doc catalog covers only a subset of components** — for categories without a doc, read the matching reference files from the [`igniteui-angular-components`](../igniteui-angular-components/SKILL.md) / [`igniteui-angular-grids`](../igniteui-angular-grids/SKILL.md) skills and use `search_api` for member-level API lookups. Read one or the other before coding — it gives exact usage patterns, inputs, and template structure.
97+
For every chosen component category that appears in the `list_components` results, call `get_example({ framework: "angular", component: "<name-field-value>" })` — pass the doc `name` field from `list_components` as the `component` parameter (not the result title) — or `get_doc` when explanation context matters. **The doc catalog covers only a subset of components** — for categories without a doc, read the matching reference files from the [`igniteui-angular-components`](../igniteui-angular-components/SKILL.md) / [`igniteui-angular-grids`](../igniteui-angular-grids/SKILL.md) skills and use `search_api` for member-level API lookups. Read one or the other before coding — it gives exact usage patterns, inputs, and template structure.
9898

9999
Call `search_docs` for feature-based questions (e.g., "how to configure [component] for [specific behavior or styling need]") — it searches only the docs in the catalog.
100100

0 commit comments

Comments
 (0)