Skip to content

Commit 85e1266

Browse files
committed
more docs
1 parent fd6f19e commit 85e1266

1 file changed

Lines changed: 23 additions & 31 deletions

File tree

β€ŽAI_INTEGRATION.mdβ€Ž

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -562,11 +562,9 @@ CommandBox module authors can include AI guidelines in their packages:
562562
```
563563
your-module/
564564
β”œβ”€β”€ ModuleConfig.cfc
565-
└── resources/
566-
└── coldbox-cli/
567-
└── ai/
568-
└── guidelines/
569-
└── core.md # Auto-discovered
565+
└── .ai/
566+
└── guidelines/
567+
└── core.md # Auto-discovered
570568
```
571569

572570
**Module Guideline Template:**
@@ -818,12 +816,10 @@ Module authors can bundle skills with their packages:
818816
```
819817
your-module/
820818
β”œβ”€β”€ ModuleConfig.cfc
821-
└── resources/
822-
└── coldbox-cli/
823-
└── ai/
824-
└── skills/
825-
└── using-your-module/
826-
└── SKILL.md
819+
└── .ai/
820+
└── skills/
821+
└── using-your-module/
822+
└── SKILL.md
827823
```
828824

829825
**Module Skill Template:**
@@ -1356,7 +1352,7 @@ coldbox ai skills list | grep qb
13561352
**Discovery Process:**
13571353

13581354
1. Scans installed modules in `/modules/`
1359-
2. Looks for `resources/coldbox-cli/ai/` directory
1355+
2. Looks for `.ai/` directory at module root
13601356
3. Loads `guidelines/` and `skills/` subdirectories
13611357
4. Integrates content into agent configurations
13621358
5. Updates `.ai/manifest.json` with module sources
@@ -1366,7 +1362,7 @@ coldbox ai skills list | grep qb
13661362
flowchart TD
13671363
Install["box install qb"]
13681364
Install --> Scan["πŸ” Scan /modules/ directory"]
1369-
Scan --> Check{"Has resources/<br/>coldbox-cli/ai/?"}
1365+
Scan --> Check{"Has .ai/<br/>directory?"}
13701366
Check -->|Yes| Load["πŸ“₯ Load guidelines & skills"]
13711367
Check -->|No| Skip["⏭️ Skip module"]
13721368
Load --> Integrate["πŸ”— Integrate into .ai/ structure"]
@@ -1377,7 +1373,7 @@ flowchart TD
13771373
13781374
subgraph "Module Structure"
13791375
ModuleDir[".../modules/qb/"]
1380-
ResourceDir["resources/coldbox-cli/ai/"]
1376+
ResourceDir[".ai/"]
13811377
GuidelineFile["guidelines/core.md"]
13821378
SkillFile["skills/using-qb/SKILL.md"]
13831379
@@ -1403,14 +1399,12 @@ Module authors: Include AI guidelines in your packages:
14031399
your-module/
14041400
β”œβ”€β”€ box.json
14051401
β”œβ”€β”€ ModuleConfig.cfc
1406-
└── resources/
1407-
└── coldbox-cli/
1408-
└── ai/
1409-
└── guidelines/
1410-
└── core.md # Required
1402+
└── .ai/
1403+
└── guidelines/
1404+
└── core.md # Required
14111405
```
14121406

1413-
**Guideline Template:** (`resources/coldbox-cli/ai/guidelines/core.md`)
1407+
**Guideline Template:** (`.ai/guidelines/core.md`)
14141408

14151409
```markdown
14161410
# Module Name v1.0.0
@@ -1483,19 +1477,17 @@ Module authors: Include AI skills for complex tasks:
14831477
your-module/
14841478
β”œβ”€β”€ box.json
14851479
β”œβ”€β”€ ModuleConfig.cfc
1486-
└── resources/
1487-
└── coldbox-cli/
1488-
└── ai/
1489-
└── skills/
1490-
└── using-your-module/
1491-
β”œβ”€β”€ SKILL.md # Required
1492-
β”œβ”€β”€ templates/ # Optional
1493-
β”‚ └── example.cfc
1494-
└── scripts/ # Optional
1495-
└── setup.sh
1480+
└── .ai/
1481+
└── skills/
1482+
└── using-your-module/
1483+
β”œβ”€β”€ SKILL.md # Required
1484+
β”œβ”€β”€ templates/ # Optional
1485+
β”‚ └── example.cfc
1486+
└── scripts/ # Optional
1487+
└── setup.sh
14961488
```
14971489

1498-
**Skill Template:** (`resources/coldbox-cli/ai/skills/using-your-module/SKILL.md`)
1490+
**Skill Template:** (`.ai/skills/using-your-module/SKILL.md`)
14991491

15001492
```markdown
15011493
---

0 commit comments

Comments
Β (0)