Skip to content

Commit 162afe2

Browse files
twlitetwlite
authored
chore: add deepwiki config
1 parent 9998b11 commit 162afe2

File tree

1 file changed

+304
-0
lines changed

1 file changed

+304
-0
lines changed

‎.devin/wiki.json‎

Lines changed: 304 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,304 @@
1+
{
2+
"repo_notes": [
3+
{
4+
"content": ""
5+
}
6+
],
7+
"pages": [
8+
{
9+
"title": "Overview",
10+
"purpose": "Introduce CommandKit as a Discord.js meta-framework, explaining its purpose, key features, and overall architecture at a high level",
11+
"page_notes": [
12+
{
13+
"content": ""
14+
}
15+
]
16+
},
17+
{
18+
"title": "Monorepo Structure",
19+
"purpose": "Document the monorepo organization, workspace packages, shared configurations, and how the packages relate to each other",
20+
"parent": "Overview",
21+
"page_notes": [
22+
{
23+
"content": ""
24+
}
25+
]
26+
},
27+
{
28+
"title": "Package Ecosystem",
29+
"purpose": "Catalog all packages in the monorepo (core, plugins, apps) with brief descriptions and their relationships",
30+
"parent": "Overview",
31+
"page_notes": [
32+
{
33+
"content": ""
34+
}
35+
]
36+
},
37+
{
38+
"title": "Getting Started",
39+
"purpose": "Guide users through creating their first CommandKit bot, from scaffolding to running their first commands",
40+
"page_notes": [
41+
{
42+
"content": ""
43+
}
44+
]
45+
},
46+
{
47+
"title": "Installation and Project Setup",
48+
"purpose": "Explain how to use create-commandkit to scaffold a new project, including template options and configuration",
49+
"parent": "Getting Started",
50+
"page_notes": [
51+
{
52+
"content": ""
53+
}
54+
]
55+
},
56+
{
57+
"title": "Configuration System",
58+
"purpose": "Document commandkit.config.ts structure, available options, and how to configure the framework",
59+
"parent": "Getting Started",
60+
"page_notes": [
61+
{
62+
"content": ""
63+
}
64+
]
65+
},
66+
{
67+
"title": "Core Framework",
68+
"purpose": "Deep dive into the CommandKit class, initialization lifecycle, and fundamental architecture",
69+
"page_notes": [
70+
{
71+
"content": ""
72+
}
73+
]
74+
},
75+
{
76+
"title": "Command System",
77+
"purpose": "Explain how commands work, including command types (slash, message, context menu), file structure, and registration",
78+
"parent": "Core Framework",
79+
"page_notes": [
80+
{
81+
"content": ""
82+
}
83+
]
84+
},
85+
{
86+
"title": "Chat Input Commands (Slash Commands)",
87+
"purpose": "Detail slash command implementation, options, autocomplete, and Discord API integration",
88+
"parent": "Core Framework",
89+
"page_notes": [
90+
{
91+
"content": ""
92+
}
93+
]
94+
},
95+
{
96+
"title": "Message Commands",
97+
"purpose": "Document prefix-based message commands, argument parsing, and prefix resolution system",
98+
"parent": "Core Framework",
99+
"page_notes": [
100+
{
101+
"content": ""
102+
}
103+
]
104+
},
105+
{
106+
"title": "Context Menu Commands",
107+
"purpose": "Explain user and message context menu commands, their registration and execution",
108+
"parent": "Core Framework",
109+
"page_notes": [
110+
{
111+
"content": ""
112+
}
113+
]
114+
},
115+
{
116+
"title": "Command Metadata",
117+
"purpose": "Document metadata system for permissions, guilds, aliases, and command customization",
118+
"parent": "Core Framework",
119+
"page_notes": [
120+
{
121+
"content": ""
122+
}
123+
]
124+
},
125+
{
126+
"title": "Event System",
127+
"purpose": "Explain Discord.js event handling, event file structure, parallel/sequential execution, and custom events",
128+
"parent": "Core Framework",
129+
"page_notes": [
130+
{
131+
"content": ""
132+
}
133+
]
134+
},
135+
{
136+
"title": "Context and Execution",
137+
"purpose": "Document the Context object, execution modes, environment management, and AsyncLocalStorage usage",
138+
"parent": "Core Framework",
139+
"page_notes": [
140+
{
141+
"content": ""
142+
}
143+
]
144+
},
145+
{
146+
"title": "Context API",
147+
"purpose": "Detail all Context properties and methods, type guards, and context cloning",
148+
"parent": "Core Framework",
149+
"page_notes": [
150+
{
151+
"content": ""
152+
}
153+
]
154+
},
155+
{
156+
"title": "Environment and AsyncLocalStorage",
157+
"purpose": "Explain CommandKitEnvironment, how context propagates across async operations, and deferred functions",
158+
"parent": "Core Framework",
159+
"page_notes": [
160+
{
161+
"content": ""
162+
}
163+
]
164+
},
165+
{
166+
"title": "Middleware System",
167+
"purpose": "Document middleware types (global, directory, command), execution order, and control signals",
168+
"parent": "Core Framework",
169+
"page_notes": [
170+
{
171+
"content": ""
172+
}
173+
]
174+
},
175+
{
176+
"title": "Command Registration",
177+
"purpose": "Explain how commands are registered with Discord's API, global vs guild commands, and update strategies",
178+
"parent": "Core Framework",
179+
"page_notes": [
180+
{
181+
"content": ""
182+
}
183+
]
184+
},
185+
{
186+
"title": "Plugin System",
187+
"purpose": "Introduce the plugin architecture, RuntimePlugin vs CompilerPlugin, lifecycle hooks, and plugin development",
188+
"page_notes": [
189+
{
190+
"content": ""
191+
}
192+
]
193+
},
194+
{
195+
"title": "Plugin Lifecycle and Hooks",
196+
"purpose": "Document all plugin lifecycle hooks (bootstrap, loading, registration, runtime) and when they execute",
197+
"parent": "Plugin System",
198+
"page_notes": [
199+
{
200+
"content": ""
201+
}
202+
]
203+
},
204+
{
205+
"title": "Creating Plugins",
206+
"purpose": "Guide for developing custom RuntimePlugins and CompilerPlugins with examples",
207+
"parent": "Plugin System",
208+
"page_notes": [
209+
{
210+
"content": ""
211+
}
212+
]
213+
},
214+
{
215+
"title": "Official Plugins",
216+
"purpose": "Overview of all official @commandkit/* plugins and their purposes",
217+
"page_notes": [
218+
{
219+
"content": ""
220+
}
221+
]
222+
},
223+
{
224+
"title": "AI Plugin (@commandkit/ai)",
225+
"purpose": "Document AI command execution, command-to-tool transformation, AI context, and model integration",
226+
"parent": "Official Plugins",
227+
"page_notes": [
228+
{
229+
"content": ""
230+
}
231+
]
232+
},
233+
{
234+
"title": "AI Configuration and Models",
235+
"purpose": "Explain configureAI options, model selection, prompt preparation, and message filtering",
236+
"parent": "Official Plugins",
237+
"page_notes": [
238+
{
239+
"content": ""
240+
}
241+
]
242+
},
243+
{
244+
"title": "Commands as AI Tools",
245+
"purpose": "Detail how to expose commands as AI-executable tools, aiConfig, and parameter extraction",
246+
"parent": "Official Plugins",
247+
"page_notes": [
248+
{
249+
"content": ""
250+
}
251+
]
252+
},
253+
{
254+
"title": "AI Context and Built-in Tools",
255+
"purpose": "Document AiContext, useAIContext hook, and default tools like createEmbed and getChannelById",
256+
"parent": "Official Plugins",
257+
"page_notes": [
258+
{
259+
"content": ""
260+
}
261+
]
262+
},
263+
{
264+
"title": "i18n Plugin (@commandkit/i18n)",
265+
"purpose": "Document internationalization plugin, locale file structure, command translation, and runtime usage",
266+
"parent": "Official Plugins",
267+
"page_notes": [
268+
{
269+
"content": ""
270+
}
271+
]
272+
},
273+
{
274+
"title": "i18n Setup and Configuration",
275+
"purpose": "Explain i18n plugin initialization, i18next configuration, and locale directory structure",
276+
"parent": "Official Plugins",
277+
"page_notes": [
278+
{
279+
"content": ""
280+
}
281+
]
282+
},
283+
{
284+
"title": "Command Localization",
285+
"purpose": "Detail translation metadata keys, command name/description localization, and Discord API integration",
286+
"parent": "Official Plugins",
287+
"page_notes": [
288+
{
289+
"content": ""
290+
}
291+
]
292+
},
293+
{
294+
"title": "Runtime Translation",
295+
"purpose": "Document ctx.locale(), fetchT(), and useI18n() hooks for accessing translations in commands and events",
296+
"parent": "Official Plugins",
297+
"page_notes": [
298+
{
299+
"content": ""
300+
}
301+
]
302+
}
303+
]
304+
}

0 commit comments

Comments
 (0)