Skip to content

docs(*): update-readme-ai-assisted-development#17096

Open
radomirchev wants to merge 4 commits intomasterfrom
rmirchev/readme-update-ai-assisted-workflow
Open

docs(*): update-readme-ai-assisted-development#17096
radomirchev wants to merge 4 commits intomasterfrom
rmirchev/readme-update-ai-assisted-workflow

Conversation

@radomirchev
Copy link
Copy Markdown
Contributor

@radomirchev radomirchev commented Mar 24, 2026

Closes #

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

Checklist:

  • All relevant tags have been applied to this PR
  • This PR includes unit tests covering all the new code (test guidelines)
  • This PR includes API docs for newly added methods/properties (api docs guidelines)
  • This PR includes feature/README.MD updates for the feature docs
  • This PR includes general feature table updates in the root README.MD
  • This PR includes CHANGELOG.MD updates for newly added functionality
  • This PR contains breaking changes
  • This PR includes ng update migrations for the breaking changes (migrations guidelines)
  • This PR includes behavioral changes and the feature specification has been updated with them

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the root README to reposition Ignite UI for Angular around AI-assisted development, documenting the MCP servers, AI Skills, and providing a reorganized/condensed overview of installation, development, and component inventory.

Changes:

  • Adds a new “AI-Native Developer Tooling” section detailing the documentation MCP and theming MCP servers, including configuration examples and tool inventories.
  • Reorganizes the README structure (installation, browser support, development setup, demos, docs, contributing, support) and replaces large tables with a condensed component inventory inside a <details> block.
  • Adds an “For AI assistants and agents” section describing how to consume the repo with MCP + Skills.

- **Documentation MCP**: `ig mcp` — 6 tools for documentation search, API lookup, and scaffolding (see [MCP tool inventory](#mcp-tool-inventory) above)
- **Theming MCP**: `npx igniteui-theming/mcp` — tools for palette generation, typography, elevations, and component theming (see [Theming MCP tool inventory](#theming-mcp-tool-inventory) above)
- **AI Skills**: structured knowledge files in [`skills/`](skills/) — load for context-aware Angular code generation
- **Structured docs index**: [`llms.txt`](llms.txt) — machine-readable index of all Ignite UI documentation (when available)
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README links to llms.txt, but there is no llms.txt file in the repository root. This is a broken link as-is; either add the file in this PR or adjust the text/link to avoid pointing to a non-existent path.

Suggested change
- **Structured docs index**: [`llms.txt`](llms.txt) — machine-readable index of all Ignite UI documentation (when available)
- **Structured docs index**: `llms.txt` — machine-readable index of all Ignite UI documentation (when available; may not be present in this repository)

Copilot uses AI. Check for mistakes.
| Theming & Styling | [`skills/igniteui-angular-theming/SKILL.md`](skills/igniteui-angular-theming/SKILL.md) | Design tokens, component themes, palette generation — includes Theming MCP server setup |

Including the `igniteui-angular` and `igniteui-cli` packages to your project:
**Skills are developer-owned npm packages, not single prompt files.** Each Skill is versioned, testable, and loaded via IDE configuration — not copy-pasted into chat.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The statement "Skills are developer-owned npm packages" appears inaccurate for this repo: the skills/ entries here are version-controlled markdown files (e.g., skills/<name>/SKILL.md + references/) and not npm packages. This wording may confuse users about how Skills are distributed/consumed—consider rephrasing to describe them as repository files.

Suggested change
**Skills are developer-owned npm packages, not single prompt files.** Each Skill is versioned, testable, and loaded via IDE configuration — not copy-pasted into chat.
**Skills in this repo are version-controlled markdown files under `skills/`, not single prompt snippets or npm packages.** Each Skill is versioned, testable, and loaded via IDE configuration — not copy-pasted into chat.

Copilot uses AI. Check for mistakes.
radomirchev and others added 3 commits March 25, 2026 15:34
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Member

@kdinev kdinev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a UI component library repo. It's not an MCP server repo, it's not a theming repo, or a theming MCP server repo. This README change is as if the repo has changed, and it hasn't. It's primary purpose is to develop Ignite UI for Angular components in it, not to tell people what servers are shipped from other repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants