Skip to content

Commit 45b9788

Browse files
twlitetwlite
authored
Merge pull request #526 from underctrl-io/docgen
docs: generate api docs
2 parents 46a6096 + 97094e9 commit 45b9788

File tree

241 files changed

+634
-499
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+634
-499
lines changed

‎apps/test-bot/src/config.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"foo": "bar",
3-
"bar": {
4-
"baz": "qux"
5-
}
6-
}
2+
"foo": "bar",
3+
"bar": {
4+
"baz": "qux"
5+
}
6+
}

‎apps/website/docs/api-reference/ai/classes/ai-cli-plugin.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class AiCliPlugin extends CompilerPlugin {
2424
deactivate(ctx: CompilerPluginRuntime) => Promise<void>;
2525
}
2626
```
27-
* Extends: <code><a href='/docs/next/api-reference/commandkit/classes/compiler-plugin#compilerplugin'>CompilerPlugin</a></code>
27+
* Extends: <code><a href='/docs/api-reference/commandkit/classes/compiler-plugin#compilerplugin'>CompilerPlugin</a></code>
2828

2929

3030

@@ -37,12 +37,12 @@ class AiCliPlugin extends CompilerPlugin {
3737

3838
### activate
3939

40-
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/compiler-plugin-runtime#compilerpluginruntime'>CompilerPluginRuntime</a>) => Promise&#60;void&#62;`} />
40+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/api-reference/commandkit/classes/compiler-plugin-runtime#compilerpluginruntime'>CompilerPluginRuntime</a>) => Promise&#60;void&#62;`} />
4141

4242

4343
### deactivate
4444

45-
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/compiler-plugin-runtime#compilerpluginruntime'>CompilerPluginRuntime</a>) => Promise&#60;void&#62;`} />
45+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/api-reference/commandkit/classes/compiler-plugin-runtime#compilerpluginruntime'>CompilerPluginRuntime</a>) => Promise&#60;void&#62;`} />
4646

4747

4848

‎apps/website/docs/api-reference/ai/classes/ai-context.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class AiContext<T extends Record<string, unknown> = Record<string, unknown>> {
2525
public message!: Message;
2626
public client!: Client;
2727
public commandkit!: CommandKit;
28-
public store = new Map<string, any>();
28+
public store = new Collection<any, any>();
2929
constructor(options: AiContextOptions<T>)
3030
setParams(params: T) => void;
3131
}
@@ -50,7 +50,7 @@ The message that triggered the AI command.
5050
The client instance associated with the AI command.
5151
### commandkit
5252

53-
<MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`} />
53+
<MemberInfo kind="property" type={`<a href='/docs/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`} />
5454

5555
The CommandKit instance associated with the AI command.
5656
### store
@@ -60,7 +60,7 @@ The CommandKit instance associated with the AI command.
6060
A key-value store to hold additional data.
6161
### constructor
6262

63-
<MemberInfo kind="method" type={`(options: <a href='/docs/next/api-reference/ai/interfaces/ai-context-options#aicontextoptions'>AiContextOptions</a>&#60;T&#62;) => AiContext`} />
63+
<MemberInfo kind="method" type={`(options: <a href='/docs/api-reference/ai/interfaces/ai-context-options#aicontextoptions'>AiContextOptions</a>&#60;T&#62;) => AiContext`} />
6464

6565
Creates a new instance of AiContext.
6666
### setParams

‎apps/website/docs/api-reference/ai/classes/ai-plugin.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class AiPlugin extends RuntimePlugin<AiPluginOptions> {
2828
onAfterCommandsLoad(ctx: CommandKitPluginRuntime) => Promise<void>;
2929
}
3030
```
31-
* Extends: <code><a href='/docs/next/api-reference/commandkit/classes/runtime-plugin#runtimeplugin'>RuntimePlugin</a>&#60;<a href='/docs/next/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>&#62;</code>
31+
* Extends: <code><a href='/docs/api-reference/commandkit/classes/runtime-plugin#runtimeplugin'>RuntimePlugin</a>&#60;<a href='/docs/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>&#62;</code>
3232

3333

3434

@@ -41,22 +41,22 @@ class AiPlugin extends RuntimePlugin<AiPluginOptions> {
4141

4242
### constructor
4343

44-
<MemberInfo kind="method" type={`(options: <a href='/docs/next/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>) => AiPlugin`} />
44+
<MemberInfo kind="method" type={`(options: <a href='/docs/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>) => AiPlugin`} />
4545

4646

4747
### activate
4848

49-
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
49+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
5050

5151

5252
### deactivate
5353

54-
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
54+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
5555

5656

5757
### executeAI
5858

59-
<MemberInfo kind="method" type={`(message: Message, commandkit?: <a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>) => Promise&#60;void&#62;`} />
59+
<MemberInfo kind="method" type={`(message: Message, commandkit?: <a href='/docs/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>) => Promise&#60;void&#62;`} />
6060

6161
Executes the AI for a given message.
6262
### onBeforeCommandsLoad
@@ -66,7 +66,7 @@ Executes the AI for a given message.
6666

6767
### onAfterCommandsLoad
6868

69-
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
69+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
7070

7171

7272

‎apps/website/docs/api-reference/ai/functions/ai.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ Parameters
2424

2525
### options
2626

27-
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>`} />
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/ai/interfaces/ai-plugin-options#aipluginoptions'>AiPluginOptions</a>`} />
2828

‎apps/website/docs/api-reference/ai/functions/configure-ai.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
1313

1414
## configureAI
1515

16-
<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="197" packageName="@commandkit/ai" />
16+
<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="203" packageName="@commandkit/ai" />
1717

1818
Configures the AI plugin with the provided options.
1919
This function allows you to set a message filter, select an AI model, and generate a system prompt.
@@ -25,5 +25,5 @@ Parameters
2525

2626
### config
2727

28-
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/interfaces/configure-ai#configureai'>ConfigureAI</a>`} />
28+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/ai/interfaces/configure-ai#configureai'>ConfigureAI</a>`} />
2929

‎apps/website/docs/api-reference/ai/functions/create-tool.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ Parameters
4747

4848
### options
4949

50-
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/interfaces/create-tool-options#createtooloptions'>CreateToolOptions</a>&#60;T, R&#62;`} />
50+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/ai/interfaces/create-tool-options#createtooloptions'>CreateToolOptions</a>&#60;T, R&#62;`} />
5151

‎apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ Parameters
2424

2525
### command
2626

27-
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/commandkit/types/command-data#commanddata'>CommandData</a>`} />
27+
<MemberInfo kind="parameter" type={`<a href='/docs/api-reference/commandkit/types/command-data#commanddata'>CommandData</a>`} />
2828

‎apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
1313

1414
## getAIConfig
1515

16-
<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="188" packageName="@commandkit/ai" />
16+
<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="194" packageName="@commandkit/ai" />
1717

1818
Retrieves the current AI configuration.
1919

‎apps/website/docs/api-reference/ai/interfaces/ai-context-options.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The message that triggered the AI command.
3939
The parameters passed to the AI command.
4040
### commandkit
4141

42-
<MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`} />
42+
<MemberInfo kind="property" type={`<a href='/docs/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`} />
4343

4444
The CommandKit instance associated with the AI command.
4545

0 commit comments

Comments
 (0)