Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Revert "Feat: Update community section of docs" #1112

Merged
merged 1 commit into from
Dec 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/api/classes/AgentRuntime.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ The model to use for generateImage.

### fetch()

> **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>
> **fetch**: (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\>

Fetch function to use
Some environments may not have access to the global fetch function and need a custom fetch override.
Expand All @@ -264,6 +264,16 @@ Some environments may not have access to the global fetch function and need a cu

`Promise`\<`Response`\>

#### Parameters

• **input**: `string` \| `Request` \| `URL`

• **init?**: `RequestInit`

#### Returns

`Promise`\<`Response`\>

#### Implementation of

[`IAgentRuntime`](../interfaces/IAgentRuntime.md).[`fetch`](../interfaces/IAgentRuntime.md#fetch)
Expand Down
8 changes: 4 additions & 4 deletions docs/api/classes/Service.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

#### Defined in

[packages/core/src/types.ts:998](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L998)
[packages/core/src/types.ts:987](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L987)

***

Expand All @@ -54,7 +54,7 @@

#### Defined in

[packages/core/src/types.ts:1009](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1009)
[packages/core/src/types.ts:998](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L998)

## Methods

Expand All @@ -72,7 +72,7 @@

#### Defined in

[packages/core/src/types.ts:1002](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1002)
[packages/core/src/types.ts:991](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L991)

***

Expand All @@ -92,4 +92,4 @@ Add abstract initialize method that must be implemented by derived classes

#### Defined in

[packages/core/src/types.ts:1014](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1014)
[packages/core/src/types.ts:1003](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1003)
34 changes: 9 additions & 25 deletions docs/api/enumerations/Clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,17 @@ Available client platforms

***

### DIRECT

> **DIRECT**: `"direct"`

#### Defined in

[packages/core/src/types.ts:611](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L611)

***

### TWITTER

> **TWITTER**: `"twitter"`

you can't specify this in characters
all characters are registered with this
DIRECT = "direct",

#### Defined in

[packages/core/src/types.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L612)
[packages/core/src/types.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L614)

***

Expand All @@ -42,7 +36,7 @@ Available client platforms

#### Defined in

[packages/core/src/types.ts:613](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L613)
[packages/core/src/types.ts:615](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L615)

***

Expand All @@ -52,17 +46,7 @@ Available client platforms

#### Defined in

[packages/core/src/types.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L614)

***

### LENS

> **LENS**: `"lens"`

#### Defined in

[packages/core/src/types.ts:615](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L615)
[packages/core/src/types.ts:616](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L616)

***

Expand All @@ -72,7 +56,7 @@ Available client platforms

#### Defined in

[packages/core/src/types.ts:616](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L616)
[packages/core/src/types.ts:617](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L617)

***

Expand All @@ -82,4 +66,4 @@ Available client platforms

#### Defined in

[packages/core/src/types.ts:617](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L617)
[packages/core/src/types.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L618)
6 changes: 3 additions & 3 deletions docs/api/enumerations/LoggingLevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

#### Defined in

[packages/core/src/types.ts:1213](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1213)
[packages/core/src/types.ts:1201](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1201)

***

Expand All @@ -20,7 +20,7 @@

#### Defined in

[packages/core/src/types.ts:1214](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1214)
[packages/core/src/types.ts:1202](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1202)

***

Expand All @@ -30,4 +30,4 @@

#### Defined in

[packages/core/src/types.ts:1215](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1215)
[packages/core/src/types.ts:1203](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1203)
22 changes: 11 additions & 11 deletions docs/api/enumerations/ServiceType.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

#### Defined in

[packages/core/src/types.ts:1199](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1199)
[packages/core/src/types.ts:1187](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1187)

***

Expand All @@ -20,7 +20,7 @@

#### Defined in

[packages/core/src/types.ts:1200](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1200)
[packages/core/src/types.ts:1188](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1188)

***

Expand All @@ -30,7 +30,7 @@

#### Defined in

[packages/core/src/types.ts:1201](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1201)
[packages/core/src/types.ts:1189](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1189)

***

Expand All @@ -40,7 +40,7 @@

#### Defined in

[packages/core/src/types.ts:1202](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1202)
[packages/core/src/types.ts:1190](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1190)

***

Expand All @@ -50,7 +50,7 @@

#### Defined in

[packages/core/src/types.ts:1203](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1203)
[packages/core/src/types.ts:1191](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1191)

***

Expand All @@ -60,7 +60,7 @@

#### Defined in

[packages/core/src/types.ts:1204](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1204)
[packages/core/src/types.ts:1192](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1192)

***

Expand All @@ -70,7 +70,7 @@

#### Defined in

[packages/core/src/types.ts:1205](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1205)
[packages/core/src/types.ts:1193](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1193)

***

Expand All @@ -80,7 +80,7 @@

#### Defined in

[packages/core/src/types.ts:1206](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1206)
[packages/core/src/types.ts:1194](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1194)

***

Expand All @@ -90,7 +90,7 @@

#### Defined in

[packages/core/src/types.ts:1207](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1207)
[packages/core/src/types.ts:1195](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1195)

***

Expand All @@ -100,7 +100,7 @@

#### Defined in

[packages/core/src/types.ts:1208](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1208)
[packages/core/src/types.ts:1196](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1196)

***

Expand All @@ -110,4 +110,4 @@

#### Defined in

[packages/core/src/types.ts:1209](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1209)
[packages/core/src/types.ts:1197](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1197)
6 changes: 3 additions & 3 deletions docs/api/functions/findNearestEnvFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

# Function: findNearestEnvFile()

> **findNearestEnvFile**(`startDir`?): `any`
> **findNearestEnvFile**(`startDir`?): `string`

Recursively searches for a .env file starting from the current directory
and moving up through parent directories (Node.js only)

## Parameters

• **startDir?**: `any` = `...`
• **startDir?**: `string` = `...`

Starting directory for the search

## Returns

`any`
`string`

Path to the nearest .env file or null if not found

Expand Down
2 changes: 1 addition & 1 deletion docs/api/functions/validateCharacterConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Validation function

## Defined in

[packages/core/src/environment.ts:138](https://github.com/ai16z/eliza/blob/main/packages/core/src/environment.ts#L138)
[packages/core/src/environment.ts:133](https://github.com/ai16z/eliza/blob/main/packages/core/src/environment.ts#L133)
1 change: 0 additions & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
- [Account](interfaces/Account.md)
- [Participant](interfaces/Participant.md)
- [Room](interfaces/Room.md)
- [IAgentConfig](interfaces/IAgentConfig.md)
- [IDatabaseAdapter](interfaces/IDatabaseAdapter.md)
- [IDatabaseCacheAdapter](interfaces/IDatabaseCacheAdapter.md)
- [IMemoryManager](interfaces/IMemoryManager.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/api/interfaces/ActionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

#### Defined in

[packages/core/src/types.ts:1224](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1224)
[packages/core/src/types.ts:1212](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1212)

***

Expand All @@ -20,7 +20,7 @@

#### Defined in

[packages/core/src/types.ts:1225](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1225)
[packages/core/src/types.ts:1213](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1213)

***

Expand All @@ -30,7 +30,7 @@

#### Defined in

[packages/core/src/types.ts:1226](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1226)
[packages/core/src/types.ts:1214](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1214)

***

Expand All @@ -40,4 +40,4 @@

#### Defined in

[packages/core/src/types.ts:1227](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1227)
[packages/core/src/types.ts:1215](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L1215)
2 changes: 1 addition & 1 deletion docs/api/interfaces/GenerationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Configuration options for generating objects with a model.

### schema?

> `optional` **schema**: `ZodSchema`
> `optional` **schema**: `ZodType`\<`any`, `ZodTypeDef`, `any`\>

#### Defined in

Expand Down
7 changes: 0 additions & 7 deletions docs/api/interfaces/IAgentConfig.md

This file was deleted.

Loading
Loading