Skip to content

docs(contact-center): add ai-docs SDD pattern documentation #4723

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.

Sign up for GitHub

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

Merged
ciscoRankush merged 4 commits into from
Feb 25, 2026
Merged

docs(contact-center): add ai-docs SDD pattern documentation #4723

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b25a96
feat(contact-center): add ai-docs SDD pattern documentation
Feb 19, 2026
38ed51a
fix(contact-center): address PR #4723 review comments on SDD pattern …
Feb 24, 2026
a209bc4
fix(contact-center): correct 3 code accuracy issues in pattern docs
Feb 24, 2026
f5cd0f0
fix(contact-center): clarify trigger vs emit in event-driven patterns…
Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions packages/@webex/contact-center/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The only exception is **Type E (Understand Architecture)** which is read-only.

### 3. MetricsManager Usage (MANDATORY)

All operations must track metrics using `timeEvent` + `trackEvent`. See full pattern in [`ai-docs/RULES.md`](ai-docs/RULES.md) and [`ai-docs/patterns/sdk-plugin-patterns.md`](ai-docs/patterns/sdk-plugin-patterns.md).
All operations must track metrics using `timeEvent` + `trackEvent`. See full pattern in [`ai-docs/RULES.md`](ai-docs/RULES.md).

---

Expand All @@ -227,7 +227,7 @@ Use defined event constants (`CC_EVENTS`, `AGENT_EVENTS`, `TASK_EVENTS`), never

### 6. WebexPlugin Extension Pattern (MANDATORY)

Follow the established `cc.ts` plugin class pattern with JSDoc (`@public`, `@param`, `@returns`, `@example`). See full pattern in [`ai-docs/patterns/sdk-plugin-patterns.md`](ai-docs/patterns/sdk-plugin-patterns.md).
Follow the established `cc.ts` plugin class pattern with JSDoc (`@public`, `@param`, `@returns`, `@example`). Refer to `src/cc.ts` directly for the canonical implementation.

---

Expand Down Expand Up @@ -265,7 +265,7 @@ Mandatory behavior:
### For New Service/Method:
1. Load the affected service's docs via [Service Routing Table](#service-routing-table)
2. Read [`ai-docs/patterns/typescript-patterns.md`](ai-docs/patterns/typescript-patterns.md)
3. Read [`ai-docs/patterns/sdk-plugin-patterns.md`](ai-docs/patterns/sdk-plugin-patterns.md)
3. Read [`ai-docs/patterns/event-driven-patterns.md`](ai-docs/patterns/event-driven-patterns.md)
4. Read [`ai-docs/patterns/testing-patterns.md`](ai-docs/patterns/testing-patterns.md)
5. Read existing service in same category (e.g., `AddressBook.ts` for new data service)

Expand Down Expand Up @@ -434,5 +434,3 @@ Use this table to identify which service's ai-docs to load based on the develope
- **TypeScript patterns**: [`ai-docs/patterns/typescript-patterns.md`](ai-docs/patterns/typescript-patterns.md)
- **Testing patterns**: [`ai-docs/patterns/testing-patterns.md`](ai-docs/patterns/testing-patterns.md)
- **Event patterns**: [`ai-docs/patterns/event-driven-patterns.md`](ai-docs/patterns/event-driven-patterns.md)
- **WebSocket patterns**: [`ai-docs/patterns/websocket-patterns.md`](ai-docs/patterns/websocket-patterns.md)
- **Plugin patterns**: [`ai-docs/patterns/sdk-plugin-patterns.md`](ai-docs/patterns/sdk-plugin-patterns.md)
4 changes: 1 addition & 3 deletions packages/@webex/contact-center/ai-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@ packages/@webex/contact-center/
├── patterns/ # Pattern documentation
│ ├── typescript-patterns.md
│ ├── testing-patterns.md
│ ├── event-driven-patterns.md
│ ├── websocket-patterns.md
│ └── sdk-plugin-patterns.md
│ └── event-driven-patterns.md
└── templates/ # Code generation templates
├── README.md
├── new-service/ # Creating new services
Expand Down
4 changes: 1 addition & 3 deletions packages/@webex/contact-center/ai-docs/RULES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| Element | Convention | Example |
|---------|------------|---------|
| Classes | PascalCase | `ContactCenter`, `TaskManager` |
| Interfaces | PascalCase (no `I` prefix in this codebase) | `Profile`, `AgentLogin` |
| Interfaces | PascalCase with `I` prefix for contracts | `IContactCenter`, `ITask`, `IVoice` |
| Types | PascalCase | `SetStateResponse`, `BuddyAgentsResponse` |
| Enums/Constants | SCREAMING_SNAKE_CASE | `CC_EVENTS`, `METRIC_EVENT_NAMES` |
| Methods | camelCase | `stationLogin`, `setAgentState` |
Expand Down Expand Up @@ -453,5 +453,3 @@ Before submitting code:
- **TypeScript patterns**: [`patterns/typescript-patterns.md`](patterns/typescript-patterns.md)
- **Testing patterns**: [`patterns/testing-patterns.md`](patterns/testing-patterns.md)
- **Event patterns**: [`patterns/event-driven-patterns.md`](patterns/event-driven-patterns.md)
- **WebSocket patterns**: [`patterns/websocket-patterns.md`](patterns/websocket-patterns.md)
- **Plugin patterns**: [`patterns/sdk-plugin-patterns.md`](patterns/sdk-plugin-patterns.md)
Loading
Loading