-
Notifications
You must be signed in to change notification settings - Fork 62
docs(ai-docs): add core AI-docs framework - README, AGENTS, RULES #571
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
docs(ai-docs): add core AI-docs framework - README, AGENTS, RULES #571
Conversation
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
adhmenon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
|
||
| ## Related Documentation | ||
|
|
||
| - **Repository Rules:** [RULES.md](./RULES.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Path for Rules.md is correct ?
|
|
||
| **A. Create New Widget** | ||
| - Developer wants to build a completely new widget from scratch | ||
| - **Route to:** [templates/new-widget/00-master.md](./ai-docs/templates/new-widget/00-master.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i can see some deviation in many links . for example
[templates/new-widget/00-master.md](./ai-docs/templates/new-widget/00-master.md)
Title doesn't include "ai-docs" , but link is correct . i can see almost all the links are like that , may be LLM has not corrected them
COMPLETES N/A - Documentation Enhancement
This pull request addresses
Adding the core AI-driven development documentation framework to enable AI assistants (like GitHub Copilot, Cursor, etc.) to better understand and work with the Contact Center Widgets codebase.
by making the following changes
ai-docs/README.md- Overview of the monorepo, technologies, components, and development workflowai-docs/AGENTS.md- Main orchestrator for AI assistants with task routing, SDK consultation, and validation workflowsai-docs/RULES.md- Repository-wide architectural principles, naming conventions, and standardsChange Type
The following scenarios were tested
The GAI Coding Policy And Copyright Annotation Best Practices
Checklist before merging
Make sure to have followed the contributing guidelines before submitting.