Skip to content

Commit fd1fe37

Browse files
twlitetwlite
committed
refactor: docs site
1 parent f955986 commit fd1fe37

File tree

747 files changed

+18830
-6833
lines changed

Some content is hidden

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

747 files changed

+18830
-6833
lines changed

‎apps/test-bot/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@
2424
"devDependencies": {
2525
"tsx": "^4.7.0"
2626
}
27-
}
27+
}

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: "AiContext"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## AiContext
15+
16+
<GenerationInfo sourceFile="packages/ai/src/context.ts" sourceLine="12" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
class AiContext<T extends Record<string, unknown> = Record<string, unknown>> {
22+
public params!: T;
23+
public message!: Message;
24+
public client!: Client;
25+
public commandkit!: CommandKit;
26+
constructor(options: AiContextOptions<T>)
27+
setParams(params: T) => void;
28+
}
29+
```
30+
31+
<div className="members-wrapper">
32+
33+
### params
34+
35+
<MemberInfo kind="property" type={`T`} />
36+
37+
38+
### message
39+
40+
<MemberInfo kind="property" type={`Message`} />
41+
42+
43+
### client
44+
45+
<MemberInfo kind="property" type={`Client`} />
46+
47+
48+
### commandkit
49+
50+
<MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`} />
51+
52+
53+
### constructor
54+
55+
<MemberInfo kind="method" type={`(options: <a href='/docs/next/api-reference/ai/interfaces/ai-context-options#aicontextoptions'>AiContextOptions</a>&#60;T&#62;) => AiContext`} />
56+
57+
58+
### setParams
59+
60+
<MemberInfo kind="method" type={`(params: T) => void`} />
61+
62+
63+
64+
65+
</div>

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

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: "AiPlugin"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## AiPlugin
15+
16+
<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="48" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
class AiPlugin extends RuntimePlugin<AiPluginOptions> {
22+
public readonly name = 'AiPlugin';
23+
constructor(options: AiPluginOptions)
24+
activate(ctx: CommandKitPluginRuntime) => Promise<void>;
25+
deactivate(ctx: CommandKitPluginRuntime) => Promise<void>;
26+
onBeforeCommandsLoad(ctx: CommandKitPluginRuntime) => Promise<void>;
27+
onAfterCommandsLoad(ctx: CommandKitPluginRuntime) => Promise<void>;
28+
}
29+
```
30+
* Extends: <code><a href='/docs/next/api-reference/commandkit/classes/runtime-plugin#runtimeplugin'>RuntimePlugin</a>&#60;AiPluginOptions&#62;</code>
31+
32+
33+
34+
<div className="members-wrapper">
35+
36+
### name
37+
38+
<MemberInfo kind="property" type={``} />
39+
40+
41+
### constructor
42+
43+
<MemberInfo kind="method" type={`(options: AiPluginOptions) => AiPlugin`} />
44+
45+
46+
### activate
47+
48+
<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+
50+
51+
### deactivate
52+
53+
<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+
55+
56+
### onBeforeCommandsLoad
57+
58+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
59+
60+
61+
### onAfterCommandsLoad
62+
63+
<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`} />
64+
65+
66+
67+
68+
</div>

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Classes"
3+
isDefaultIndex: true
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
import DocCardList from '@theme/DocCardList';
15+
16+
<DocCardList />

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "AI"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## ai
15+
16+
<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="4" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
function ai(options?: AiPluginOptions): void
22+
```
23+
Parameters
24+
25+
### options
26+
27+
<MemberInfo kind="parameter" type={`AiPluginOptions`} />
28+

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "ConfigureAI"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## configureAI
15+
16+
<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="34" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
function configureAI(config: ConfigureAI): void
22+
```
23+
Parameters
24+
25+
### config
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/interfaces/configure-ai#configureai'>ConfigureAI</a>`} />
28+

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "GetAiWorkerContext"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## getAiWorkerContext
15+
16+
<GenerationInfo sourceFile="packages/ai/src/ai-context-worker.ts" sourceLine="7" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
function getAiWorkerContext(): { message: Message; ctx: AiContext }
22+
```

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Functions"
3+
isDefaultIndex: true
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
import DocCardList from '@theme/DocCardList';
15+
16+
<DocCardList />

‎apps/website/docs/api-reference/ai/functions/run-in-ai-worker-context.mdx‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "RunInAiWorkerContext"
3+
isDefaultIndex: false
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
## runInAiWorkerContext
15+
16+
<GenerationInfo sourceFile="packages/ai/src/ai-context-worker.ts" sourceLine="19" packageName="@commandkit/ai" />
17+
18+
19+
20+
```ts title="Signature"
21+
function runInAiWorkerContext<R, F extends (...args: any[]) => R>(ctx: AiContext, message: Message, callback: F): R
22+
```
23+
Parameters
24+
25+
### ctx
26+
27+
<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>`} />
28+
29+
### message
30+
31+
<MemberInfo kind="parameter" type={`Message`} />
32+
33+
### callback
34+
35+
<MemberInfo kind="parameter" type={`F`} />
36+

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "AI"
3+
isDefaultIndex: true
4+
generated: true
5+
---
6+
7+
import MemberInfo from '@site/src/components/MemberInfo';
8+
import GenerationInfo from '@site/src/components/GenerationInfo';
9+
import MemberDescription from '@site/src/components/MemberDescription';
10+
11+
<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
12+
13+
14+
import DocCardList from '@theme/DocCardList';
15+
16+
<DocCardList />

0 commit comments

Comments
 (0)