Skip to content

Commit 2d4e420

Browse files
committed
more docs
1 parent 60aa4fe commit 2d4e420

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

β€ŽAI_INTEGRATION.mdβ€Ž

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -98,21 +98,21 @@ graph TB
9898
Agents["πŸ€– Agents<br/>(6 Supported)<br/>Claude, Copilot, Cursor<br/>Codex, Gemini, OpenCode"]
9999
MCP["🌐 MCP Servers<br/>(30+ Built-in)<br/>Extended AI capabilities<br/>via protocol"]
100100
end
101-
101+
102102
subgraph "Sources"
103103
Core["Core<br/>(Built-in)"]
104104
Modules["Modules<br/>(Auto-discovered)"]
105105
Custom["Custom<br/>(Project-specific)"]
106106
Override["Overrides<br/>(Customizations)"]
107107
end
108-
108+
109109
subgraph "AI Assistants"
110110
Claude["Claude Desktop/Code"]
111111
Copilot["GitHub Copilot"]
112112
Cursor["Cursor IDE"]
113113
Other["Codex/Gemini/OpenCode"]
114114
end
115-
115+
116116
Core --> Guidelines
117117
Core --> Skills
118118
Modules --> Guidelines
@@ -121,16 +121,16 @@ graph TB
121121
Custom --> Skills
122122
Override --> Guidelines
123123
Override --> Skills
124-
124+
125125
Guidelines --> Agents
126126
Skills --> Agents
127127
MCP --> Agents
128-
128+
129129
Agents --> Claude
130130
Agents --> Copilot
131131
Agents --> Cursor
132132
Agents --> Other
133-
133+
134134
style Guidelines fill:#e1f5ff,stroke:#01579b
135135
style Skills fill:#fff9e1,stroke:#f57f17
136136
style Agents fill:#f3e5f5,stroke:#4a148c
@@ -172,7 +172,7 @@ flowchart TD
172172
CreateStructure --> GenerateConfigs["βš™οΈ Generate agent configs<br/>CLAUDE.md, .cursorrules, etc."]
173173
GenerateConfigs --> SyncModules["πŸ”„ Sync module resources"]
174174
SyncModules --> Complete(["βœ… Installation Complete"])
175-
175+
176176
style Start fill:#4caf50,color:#fff
177177
style Complete fill:#2e7d32,color:#fff
178178
style Detect fill:#ff9800,color:#fff
@@ -203,30 +203,30 @@ After installation, the following structure is created in your project:
203203
```mermaid
204204
graph TD
205205
Root[".ai/"]
206-
206+
207207
Root --> Guidelines["πŸ“š guidelines/"]
208208
Root --> Skills["🎯 skills/"]
209209
Root --> MCP["🌐 mcp-servers/"]
210210
Root --> Manifest["πŸ“‹ manifest.json"]
211-
211+
212212
Guidelines --> GCore["βš™οΈ core/<br/>(8 guidelines)"] Guidelines --> GModules["πŸ“¦ modules/<br/>(28 guidelines)"]
213213
Guidelines --> GCustom["πŸ“ custom/<br/>(Your guidelines)"]
214214
Guidelines --> GOverride["🎯 overrides/<br/>(Customizations)"]
215-
215+
216216
Skills --> SCore["βš™οΈ core/<br/>(62 skills)"]
217217
Skills --> SModules["πŸ“¦ modules/<br/>(Module skills)"]
218218
Skills --> SCustom["πŸ“ custom/<br/>(Your skills)"]
219219
Skills --> SOverride["🎯 overrides/<br/>(Customizations)"]
220-
220+
221221
MCP --> MCPCore["βš™οΈ core/<br/>(30+ servers)"]
222222
MCP --> MCPCustom["πŸ“ custom/<br/>(Your servers)"]
223-
223+
224224
Root --> Agents["Agent Configs"]
225225
Agents --> Claude["CLAUDE.md"]
226226
Agents --> Copilot[".github/copilot-instructions.md"]
227227
Agents --> Cursor[".cursorrules"]
228228
Agents --> Other["+ 3 more agents"]
229-
229+
230230
style Root fill:#9c27b0,color:#fff
231231
style Guidelines fill:#2196f3,color:#fff
232232
style Skills fill:#ffc107,color:#000
@@ -319,28 +319,28 @@ graph LR
319319
G3["πŸ“š Handler Conventions"]
320320
G4["πŸ“š Routing"]
321321
end
322-
322+
323323
subgraph "AI Agent Context"
324324
Agent["πŸ€– AI Assistant<br/>Always loaded"]
325325
end
326-
326+
327327
subgraph "Skills (On-Demand)"
328328
S1["🎯 Creating REST APIs"]
329329
S2["🎯 Writing Tests"]
330330
S3["🎯 Database Migrations"]
331331
S4["🎯 Async Programming"]
332332
end
333-
333+
334334
G1 --> Agent
335335
G2 --> Agent
336336
G3 --> Agent
337337
G4 --> Agent
338-
338+
339339
Agent -."Invoke when needed".-> S1
340340
Agent -."Invoke when needed".-> S2
341341
Agent -."Invoke when needed".-> S3
342342
Agent -."Invoke when needed".-> S4
343-
343+
344344
style Agent fill:#9c27b0,color:#fff
345345
style G1 fill:#2196f3,color:#fff
346346
style G2 fill:#2196f3,color:#fff
@@ -374,15 +374,15 @@ flowchart LR
374374
Guidelines["πŸ“š Guidelines<br/>~85 KB"]
375375
Skills["🎯 Skills<br/>~124 KB"]
376376
Total["πŸ’Ύ Total Context<br/>~209 KB<br/>~62,700 tokens"]
377-
377+
378378
Guidelines --> Total
379379
Skills --> Total
380-
380+
381381
Total --> Claude["Claude 3.5<br/>200K tokens<br/>7.84% used"]
382382
Total --> GPT4["GPT-4<br/>128K tokens<br/>12.27% used"]
383383
Total --> GPT35["GPT-3.5-Turbo<br/>16K tokens<br/>⚠️ 97.97% used"]
384384
Total --> Gemini["Gemini 1.5 Pro<br/>1M tokens<br/>0.98% used"]
385-
385+
386386
style Total fill:#ff9800,color:#fff
387387
style Claude fill:#4caf50,color:#fff
388388
style GPT4 fill:#8bc34a,color:#000
@@ -494,25 +494,25 @@ graph TD
494494
Module["πŸ“¦ Modules<br/>.ai/guidelines/modules/<br/>From installed packages"]
495495
Core["βš™οΈ Core<br/>.ai/guidelines/core/<br/>Built-in (Lowest Priority)"]
496496
end
497-
497+
498498
Override -."Replaces".-> Core
499499
Override -."Replaces".-> Module
500500
Custom -."Adds to".-> Module
501501
Module -."Extends".-> Core
502-
502+
503503
subgraph "Example: coldbox.md"
504504
Check{"Which version<br/>to use?"}
505505
UseOverride["βœ… Use override version<br/>Custom conventions"]
506506
UseModule["Use module version<br/>If no override"]
507507
UseCustom["Use custom version<br/>If exists"]
508508
UseCore["Use core version<br/>Default fallback"]
509509
end
510-
510+
511511
Check -->|"Override exists"| UseOverride
512512
Check -->|"Custom exists"| UseCustom
513513
Check -->|"Module exists"| UseModule
514514
Check -->|"None exist"| UseCore
515-
515+
516516
style Override fill:#f44336,color:#fff
517517
style Custom fill:#ff9800,color:#fff
518518
style Module fill:#2196f3,color:#fff
@@ -980,37 +980,37 @@ graph TB
980980
Skills["🎯 62+ Skills"]
981981
MCP["🌐 30+ MCP Servers"]
982982
end
983-
983+
984984
subgraph "Agent Configurations"
985985
Guidelines --> ClaudeConfig["CLAUDE.md"]
986986
Guidelines --> CopilotConfig[".github/copilot-instructions.md"]
987987
Guidelines --> CursorConfig[".cursorrules"]
988988
Guidelines --> CodexConfig[".codex/instructions.md"]
989989
Guidelines --> GeminiConfig[".gemini/instructions.md"]
990990
Guidelines --> OpenCodeConfig[".opencode/instructions.md"]
991-
991+
992992
Skills --> ClaudeConfig
993993
Skills --> CopilotConfig
994994
Skills --> CursorConfig
995995
Skills --> CodexConfig
996996
Skills --> GeminiConfig
997997
Skills --> OpenCodeConfig
998-
998+
999999
MCP --> ClaudeConfig
10001000
end
1001-
1001+
10021002
subgraph "Team Members"
10031003
ClaudeConfig --> Dev1["πŸ‘¨β€πŸ’» Developer 1<br/>Uses Claude"]
10041004
CopilotConfig --> Dev2["πŸ‘©β€πŸ’» Developer 2<br/>Uses Copilot"]
10051005
CursorConfig --> Dev3["πŸ‘¨β€πŸ’» Developer 3<br/>Uses Cursor"]
10061006
CodexConfig --> Dev4["πŸ‘©β€πŸ’» Developer 4<br/>Uses Codex"]
10071007
end
1008-
1008+
10091009
Dev1 -."All follow same standards".-> Standards["βœ… Consistent Code Quality"]
10101010
Dev2 -.-> Standards
10111011
Dev3 -.-> Standards
10121012
Dev4 -.-> Standards
1013-
1013+
10141014
style Guidelines fill:#2196f3,color:#fff
10151015
style Skills fill:#ffc107,color:#000
10161016
style MCP fill:#4caf50,color:#fff
@@ -1388,18 +1388,18 @@ flowchart TD
13881388
Update --> Refresh["πŸ”„ Refresh agent configs"]
13891389
Refresh --> Complete(["βœ… QB guidelines & skills available"])
13901390
Skip --> End(["Done"])
1391-
1391+
13921392
subgraph "Module Structure"
13931393
ModuleDir[".../modules/qb/"]
13941394
ResourceDir["resources/coldbox-cli/ai/"]
13951395
GuidelineFile["guidelines/core.md"]
13961396
SkillFile["skills/using-qb/SKILL.md"]
1397-
1397+
13981398
ModuleDir --> ResourceDir
13991399
ResourceDir --> GuidelineFile
14001400
ResourceDir --> SkillFile
14011401
end
1402-
1402+
14031403
style Install fill:#2196f3,color:#fff
14041404
style Complete fill:#4caf50,color:#fff
14051405
style Load fill:#ff9800,color:#fff

0 commit comments

Comments
Β (0)