feat(contact-center): add core AI-docs framework#4687
feat(contact-center): add core AI-docs framework#4687ciscoRankush wants to merge 1 commit intowebex:nextfrom
Conversation
Add comprehensive AI documentation framework for LLM-assisted development: - AGENTS.md: Main orchestrator for AI task routing - RULES.md: Coding standards, patterns, and conventions - README.md: Package overview and quick start - Patterns: TypeScript, testing, event-driven, WebSocket, SDK plugin - Templates: New service, new method, bug fix, feature enhancement - sdk-api-reference.json: Full public API surface Co-authored-by: Cursor <cursoragent@cursor.com>
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b792d0dcbc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| yarn workspace @webex/contact-center typecheck | ||
|
|
||
| # Lint | ||
| yarn workspace @webex/contact-center lint |
There was a problem hiding this comment.
This checklist requires yarn workspace @webex/contact-center typecheck and yarn workspace @webex/contact-center lint, but packages/@webex/contact-center/package.json defines neither script (it has test:style, test:unit, build, etc.). As written, validation fails before actual checks run, so agents following the template cannot complete the documented workflow.
Useful? React with 👍 / 👎.
| 1. [`../patterns/typescript-patterns.md`](../patterns/typescript-patterns.md) | ||
| 2. [`../patterns/sdk-plugin-patterns.md`](../patterns/sdk-plugin-patterns.md) - For cc.ts methods | ||
| 3. [`../patterns/testing-patterns.md`](../patterns/testing-patterns.md) |
There was a problem hiding this comment.
The required pattern links use ../patterns/..., which resolves to ai-docs/templates/patterns/... from this directory and does not exist; the actual docs are under ai-docs/patterns/.... This sends users to dead links at the start of the method workflow, so the prerequisite guidance cannot be followed.
Useful? React with 👍 / 👎.
| 4. Read existing service in same category (e.g., `AddressBook.ts` for new data service) | ||
|
|
||
| ### For Bug Fix: | ||
| 1. Read the affected service's `ai-docs/ARCHITECTURE.md` |
There was a problem hiding this comment.
This bug-fix flow makes reading a service ai-docs/ARCHITECTURE.md the first required step, but there are no src/services/*/ai-docs/ARCHITECTURE.md files in the repository, so the documented path is currently impossible to execute. Either add those files or provide an explicit fallback to source/tests here.
Useful? React with 👍 / 👎.
|
Hi @ciscoRankush, This PR has been open without activity for approximately 1 month. If this is no longer needed, could you please close it? We've reached the maximum number of open PRs, which is affecting our Amplify bot functionality. If there's no response within 2 days, this PR will be closed automatically. |
|
Closing this PR due to no activity. It can be reopened later if needed. |
3 participants
Add comprehensive AI documentation framework for LLM-assisted development:
COMPLETES #< INSERT LINK TO ISSUE >
This pull request addresses
< DESCRIBE THE CONTEXT OF THE ISSUE >
by making the following changes
< DESCRIBE YOUR CHANGES >
Change Type
The following scenarios were tested
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >
The GAI Coding Policy And Copyright Annotation Best Practices
I certified that
Make sure to have followed the contributing guidelines before submitting.