refactor: update documentation to include get_example for working cod… - #2318
Open
Marina-L-Stoyanova wants to merge 2 commits into
Open
refactor: update documentation to include get_example for working cod…#2318Marina-L-Stoyanova wants to merge 2 commits into
Marina-L-Stoyanova wants to merge 2 commits into
Conversation
…e and clarify usage patterns
Marina-L-Stoyanova
requested review from
dkalinovInfra
and
a lite review from Copilot
August 10, 2026 11:54
Contributor
There was a problem hiding this comment.
Pull request overview
Updates multiple Ignite UI Web Components skill documents to introduce the new get_example MCP tool and clarify when to use get_example vs get_doc (and get_api_reference) while guiding agents toward verified, non-memory-based implementations.
Changes:
- Adds
get_exampleguidance for retrieving concise working code examples (often withlanguage: "ts"to reduce response size). - Refines documentation to position
get_docas explanation/context andget_api_referenceas exhaustive API reference. - Updates MCP lookup “patterns” across skills and reference docs to include
get_example.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/igniteui-wc-migrate-grid-lite-to-premium/SKILL.md | Adds get_example guidance for migration workflow; needs cleanup for frontmatter/tool naming consistency. |
| skills/igniteui-wc-generate-from-image-design/SKILL.md | Updates mandatory protocol and lookup steps to use get_example for working code and get_doc for context. |
| skills/igniteui-wc-generate-from-image-design/references/gotchas.md | Updates chart MCP lookup pattern and guidance to include get_example. |
| skills/igniteui-wc-generate-from-image-design/references/component-mapping.md | Updates MCP lookup pattern and import guidance to reference get_example/get_doc. |
| skills/igniteui-wc-choose-components/SKILL.md | Updates catalogue instructions and tool descriptions/snippets to include get_example. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -1,4 +1,4 @@ | |||
| --- | |||
| --- | |||
|
|
||
| 1. **Identify the current Grid Lite usage** - read the user's existing TypeScript and HTML files to understand their column configuration, cell templates, data binding, and any `dataPipelineConfiguration` usage. | ||
| 2. **Use the MCP server** - call `mcp_igniteui-cli_get_api_reference` or `mcp_igniteui-cli_get_doc` (framework: `webcomponents`) to verify current API details when in doubt. | ||
| 2. **Use the MCP server** - call `mcp_igniteui-cli_get_example` for working code examples, `mcp_igniteui-cli_get_api_reference` for API details, or `mcp_igniteui-cli_get_doc` (framework: `webcomponents`) for explanation context when in doubt. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…e and clarify usage patterns
Description
Updating skill files by adding the new MCP tool 'get_example' with explanation how and when the agents should use it.