docs: add agent-cli package documentation and Amazon Q mention (#5359)

* Initial plan

* docs: add agent-cli package documentation and Amazon Q mention

* Apply suggestions from code review

* Update README.md

* Revise README for AI Agent Support and CLI Tool

Updated documentation to include AI agent support and CLI tool usage.

* Update README.md

* Revise README for AI Agent Support and CLI Tool

Updated documentation to include AI agent support and usage instructions for the @db-ux/agent-cli tool.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Maximilian Franzke <787658+mfranzke@users.noreply.github.com>

Author: Copilot

README.md

@@ -43,27 +43,44 @@ designers, and content authors build, maintain, and scale best-of-class digital
 ## How to use
 
 1. **Install your preferred package** via npm or yarn:
-   - For React: `npm i @db-ux/react-core-components`
-   - For Angular: `npm i @db-ux/ngx-core-components`
-   - For Vue: `npm i @db-ux/v-core-components`
-   - For Web Components: `npm i @db-ux/wc-core-components`
-   - For styling only: `npm i @db-ux/core-components`
+    - For React: `npm i @db-ux/react-core-components`
+    - For Angular: `npm i @db-ux/ngx-core-components`
+    - For Vue: `npm i @db-ux/v-core-components`
+    - For Web Components: `npm i @db-ux/wc-core-components`
+    - For styling only: `npm i @db-ux/core-components`
 
 2. **Include the CSS styles** as described in the "Styling Dependencies" section of each package's `README`.
 
 > **💡 Note**: All framework packages automatically include the necessary foundation styles - you don't need to install `@db-ux/core-foundations` separately!
 
 We even provide some [examples of integrations](https://github.com/db-ux-design-system/examples).
 
+## AI Agent Support
+
+For developers using AI coding assistants like GitHub Copilot or Amazon Q, we provide the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) tool that automatically adds DB UX Design System documentation to your repository.
+
+### Quick Start
+
+Run this command in your repository:
+
+```shell
+npx @db-ux/agent-cli
+```
+
+This will create or update `.github/copilot-instructions.md` with component documentation based on your installed `@db-ux` packages, helping AI agents provide better suggestions.
+
+📖 **[Learn more about `@db-ux/agent-cli` node package](packages/agent-cli/README.md)**
+
 ## Creating Custom Components
 
 For developers looking to create custom components that extend the design system in their applications, we provide comprehensive guidance:
 
 📖 **[Creating Custom Components Guide](docs/creating-custom-components.md)** - Learn how to build your own components using design system foundations
 
 This guide covers:
+
 - **Setup and Configuration**: Getting started with the design system packages
-- **Design Principles**: Following DB UX Design System guidelines and best practices  
+- **Design Principles**: Following DB UX Design System guidelines and best practices
 - **Component Patterns**: Structured approaches to building consistent components
 - **Code Examples**: Practical implementations for cards, forms, navigation, and more
 - **Framework Support**: Specific guidance for React, Vue, Angular, and vanilla HTML/CSS

output/angular/README.md

@@ -113,17 +113,22 @@ There are 3 ways to use Events in Angular:
 ></db-input>
 ```
 
-## Documentation for AI Agents
+## AI Agent Support
 
-We provide a documentation for every component in the DB UX Design System via `docs` folder.
-To consume those documentation for AI Agents (currently GitHub Copilot) the best way is to copy the `docs` folder into your project.
+For developers using AI coding assistants like GitHub Copilot or Amazon Q, we provide the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) tool that automatically adds DB UX Design System documentation to your repository.
 
-We provide a [CLI tool (`@db-ux/agent-cli`)](https://www.npmjs.com/package/@db-ux/agent-cli) to do this automatically, which you can run with:
+### Quick Start
+
+Run this command in your repository:
 
 ```shell
 npx @db-ux/agent-cli
 ```
 
+This will create or update `.github/copilot-instructions.md` with component documentation based on your installed `@db-ux` packages, helping AI agents provide better suggestions.
+
+📖 **[Learn more about `@db-ux/agent-cli` node package](packages/agent-cli/README.md)**
+
 ## Deutsche Bahn brand
 
 As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.

output/react/README.md

@@ -59,17 +59,22 @@ import { DBButton } from '@db-ux/react-core-components';
 ...
 ```
 
-## Documentation for AI Agents
+## AI Agent Support
 
-We provide a documentation for every component in the DB UX Design System via `docs` folder.
-To consume those documentation for AI Agents (currently GitHub Copilot) the best way is to copy the `docs` folder into your project.
+For developers using AI coding assistants like GitHub Copilot or Amazon Q, we provide the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) tool that automatically adds DB UX Design System documentation to your repository.
 
-We provide a [CLI tool (`@db-ux/agent-cli`)](https://www.npmjs.com/package/@db-ux/agent-cli) to do this automatically, which you can run with:
+### Quick Start
+
+Run this command in your repository:
 
 ```shell
 npx @db-ux/agent-cli
 ```
 
+This will create or update `.github/copilot-instructions.md` with component documentation based on your installed `@db-ux` packages, helping AI agents provide better suggestions.
+
+📖 **[Learn more about `@db-ux/agent-cli` node package](packages/agent-cli/README.md)**
+
 ## Deutsche Bahn brand
 
 As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.

output/stencil/README.md

@@ -74,17 +74,22 @@ If you don't have it already, add a VS Code settings folder and file at the root
 }
 ```
 
-## Documentation for AI Agents
+## AI Agent Support
 
-We provide a documentation for every component in the DB UX Design System via `docs` folder.
-To consume those documentation for AI Agents (currently GitHub Copilot) the best way is to copy the `docs` folder into your project.
+For developers using AI coding assistants like GitHub Copilot or Amazon Q, we provide the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) tool that automatically adds DB UX Design System documentation to your repository.
 
-We provide a [CLI tool (`@db-ux/agent-cli`)](https://www.npmjs.com/package/@db-ux/agent-cli) to do this automatically, which you can run with:
+### Quick Start
+
+Run this command in your repository:
 
 ```shell
 npx @db-ux/agent-cli
 ```
 
+This will create or update `.github/copilot-instructions.md` with component documentation based on your installed `@db-ux` packages, helping AI agents provide better suggestions.
+
+📖 **[Learn more about `@db-ux/agent-cli` node package](packages/agent-cli/README.md)**
+
 ## Deutsche Bahn brand
 
 As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.

output/vue/README.md

@@ -95,17 +95,22 @@ Both Inputs in this example do the same:
 </template>
 ```
 
-## Documentation for AI Agents
+## AI Agent Support
 
-We provide a documentation for every component in the DB UX Design System via `docs` folder.
-To consume those documentation for AI Agents (currently GitHub Copilot) the best way is to copy the `docs` folder into your project.
+For developers using AI coding assistants like GitHub Copilot or Amazon Q, we provide the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) tool that automatically adds DB UX Design System documentation to your repository.
 
-We provide a [CLI tool (`@db-ux/agent-cli`)](https://www.npmjs.com/package/@db-ux/agent-cli) to do this automatically, which you can run with:
+### Quick Start
+
+Run this command in your repository:
 
 ```shell
 npx @db-ux/agent-cli
 ```
 
+This will create or update `.github/copilot-instructions.md` with component documentation based on your installed `@db-ux` packages, helping AI agents provide better suggestions.
+
+📖 **[Learn more about `@db-ux/agent-cli` node package](packages/agent-cli/README.md)**
+
 ## Deutsche Bahn brand
 
 As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.

packages/agent-cli/README.md

@@ -38,7 +38,7 @@ This is useful in monorepo setups where your DB UX packages might be installed i
 
 ### Best practices
 
-We've had the best experience with GitHub Copilot when using the following settings:
+We've had the best experience with GitHub Copilot and Amazon Q when using the following settings:
 
 - Agent mode works best for code generation and may also offer the best developer experience.
 - Regarding the provided models, GPT-4o seemed to strike the best balance between "used tokens" and performance, although "Claude Sonnet 4" is still better. However, you run out of tokens quite quickly with this model.