You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+20-51Lines changed: 20 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
This is the main orchestrator for AI assistants working on this repository. It routes you to the correct templates and documentation based on the developer's task.
6
6
7
-
**For every developer request:** (1) Identify task type (A–E below). (2) If the work is in an existing packageor widget, load that scope's ai-docs (see [Package and widget ai-docs reference](#package-and-widget-ai-docs-reference)) and follow its AGENTS.md. (3) Open the template for that type and complete its mandatory pre-steps (see [Mandatory pre-steps by task type](#mandatory-pre-steps-by-task-type)). (4) Then follow the rest of this guide and the template.
7
+
**For every developer request:** (1) Identify task type (A–F below). (2) If the work is in an existing package, widget, or test framework scope, load that scope's ai-docs (see [Package and widget ai-docs reference](#package-and-widget-ai-docs-reference)) and follow its AGENTS.md. (3) Open the template for that type and complete its mandatory pre-steps (see [Mandatory pre-steps by task type](#mandatory-pre-steps-by-task-type)). (4) Then follow the rest of this guide and the template.
8
8
9
9
---
10
10
@@ -32,35 +32,36 @@ If the developer's message contains multiple distinct task types (for example, "
32
32
### Task Types
33
33
34
34
**A. Create New Widget**
35
-
36
35
- Developer wants to build a completely new widget from scratch
-**Follow:** Feature addition workflow with backward compatibility
52
49
53
50
**D. Generate/Update Documentation Only**
54
-
55
51
- Developer needs documentation for existing code
56
52
-**Route to:**[templates/documentation/create-agent-md.md](./ai-docs/templates/documentation/create-agent-md.md) and [templates/documentation/create-architecture-md.md](./ai-docs/templates/documentation/create-architecture-md.md)
57
53
-**Follow:** Documentation templates (reusable for all packages)
58
54
59
55
**E. Understanding Architecture**
60
-
61
56
- Developer needs to understand how something works
62
57
-**Read:** That scope's `ai-docs/AGENTS.md` (usage) and `ai-docs/ARCHITECTURE.md` (technical details); use [Package and widget ai-docs reference](#package-and-widget-ai-docs-reference) to find the path.
63
-
-**Available for:** station-login, user-state, store, cc-components, cc-widgets, ui-logging, test-fixtures; for task package use per-widget ai-docs (CallControl, IncomingTask, OutdialCall, TaskList).
58
+
-**Available for:** station-login, user-state, store, cc-components, cc-widgets, ui-logging, test-fixtures, playwright; for task package use per-widget ai-docs (CallControl, IncomingTask, OutdialCall, TaskList).
59
+
60
+
**F. Playwright E2E Test Work**
61
+
- Developer wants to add/update/stabilize Playwright tests, suites, sets, or test framework docs
-[mobx-patterns.md](./ai-docs/patterns/mobx-patterns.md) - State management with observer HOC
@@ -212,29 +209,22 @@ Before generating or changing any code, you MUST complete the **pre-step section
212
209
|**cc-widgets**|[packages/contact-center/cc-widgets/ai-docs/AGENTS.md](packages/contact-center/cc-widgets/ai-docs/AGENTS.md)| Same folder |
213
210
|**ui-logging**|[packages/contact-center/ui-logging/ai-docs/AGENTS.md](packages/contact-center/ui-logging/ai-docs/AGENTS.md)| Same folder |
214
211
|**samples-cc-react-app**|[widgets-samples/cc/samples-cc-react-app/ai-docs/AGENTS.md](widgets-samples/cc/samples-cc-react-app/ai-docs/AGENTS.md)| Same folder if present |
**Task package note:** The task package has multiple widgets (CallControl, IncomingTask, OutdialCall, TaskList). When working on one of them, use that widget's ai-docs path above, not a generic task path.
- ✅ Parameters (names, types, required vs optional)
271
258
- ✅ Return type
@@ -345,7 +332,6 @@ SDK (Contact Center API)
345
332
```
346
333
347
334
**Key Rules:**
348
-
349
335
- Widget consumes SDK methods via the store (through a hook) — it NEVER calls the SDK directly
350
336
- Component NEVER accesses store (receives props)
351
337
- Always use `observer` HOC for widgets
@@ -362,7 +348,6 @@ SDK (Contact Center API)
362
348
You must have already completed that template's pre-step section (Pre-Enhancement Questions, Pre-Fix Questions, or 01-pre-questions as applicable); if not, do that first.
363
349
364
350
**During code generation:**
365
-
366
351
1. Follow pattern documentation strictly
367
352
2. Reference existing widgets for examples
368
353
3. Use proper TypeScript types (no `any`)
@@ -468,7 +453,6 @@ yarn build
468
453
```
469
454
470
455
**Common errors:**
471
-
472
456
- Missing types → Add type definitions
473
457
- Import errors → Check paths and exports
474
458
- Circular dependencies → Refactor imports
@@ -487,60 +471,51 @@ yarn build
487
471
### Documentation to Consider
488
472
489
473
**If new widget created:**
490
-
491
474
- Generated via templates (AGENTS.md + ARCHITECTURE.md)
492
475
493
476
**If widget modified:**
494
-
495
477
- Update: `packages/contact-center/{widget-name}/ai-docs/AGENTS.md` (if API changed)
0 commit comments