From f1c8ac70b42e116de9b89abca84ace53e918e5ad Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Sun, 5 Jan 2025 20:55:31 +0200 Subject: [PATCH 01/11] Update DatabaseAdapter.md --- docs/api/classes/DatabaseAdapter.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md index 2482227a5c3..f21ed40b174 100644 --- a/docs/api/classes/DatabaseAdapter.md +++ b/docs/api/classes/DatabaseAdapter.md @@ -193,7 +193,7 @@ Retrieves memories based on the specified parameters. • **params** -An object containing parameters for the memory retrieval. +An object containing parameters for memory retrieval. • **params.agentId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` @@ -299,7 +299,7 @@ An object containing parameters for the embedding retrieval. `Promise`\<`object`[]\> -A Promise that resolves to an array of objects containing embeddings and levenshtein scores. +A Promise that resolves to an array of objects containing embeddings and Levenshtein scores. #### Implementation of From ad5a1c3bdb8db71d4d6805513074db439e705fab Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:57:20 +0200 Subject: [PATCH 02/11] Update composeContext.md --- docs/api/functions/composeContext.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/functions/composeContext.md b/docs/api/functions/composeContext.md index 86aa652aa2b..30c7c66ecac 100644 --- a/docs/api/functions/composeContext.md +++ b/docs/api/functions/composeContext.md @@ -20,7 +20,7 @@ The parameters for composing the context. • **params.state**: [`State`](../interfaces/State.md) -The state object containing values to replace the placeholders in the template. +The state object contains values to replace the placeholders in the template. • **params.template**: `string` From b8a4a6a81abdabb873b3ab0dd0785dd6a67f1845 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:58:05 +0200 Subject: [PATCH 03/11] Update configureSettings.md --- docs/api/functions/configureSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/functions/configureSettings.md b/docs/api/functions/configureSettings.md index 696e4e73171..39fbaf23b80 100644 --- a/docs/api/functions/configureSettings.md +++ b/docs/api/functions/configureSettings.md @@ -10,7 +10,7 @@ Configures environment settings for browser usage • **settings**: `Settings` -Object containing environment variables +The object containing environment variables ## Returns From e6640c7d609a45627fd794701342a8c7822bd811 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Mon, 6 Jan 2025 22:40:04 +0200 Subject: [PATCH 04/11] Update splitChunks.md --- docs/api/functions/splitChunks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/functions/splitChunks.md b/docs/api/functions/splitChunks.md index f9df4ec3b60..43243be29a5 100644 --- a/docs/api/functions/splitChunks.md +++ b/docs/api/functions/splitChunks.md @@ -24,7 +24,7 @@ Number of characters to overlap between chunks (default: 100) `Promise`\<`string`[]\> -Promise resolving to array of text chunks with bleed sections +Promise resolving to an array of text chunks with bleed sections ## Defined in From 5ef4aeabe4eb304bb4bfed7552694263a8946ff7 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Wed, 8 Jan 2025 23:57:57 +0200 Subject: [PATCH 05/11] Update ActionExample.md --- docs/api/interfaces/ActionExample.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/interfaces/ActionExample.md b/docs/api/interfaces/ActionExample.md index d6766be6a31..32b9f9b8aec 100644 --- a/docs/api/interfaces/ActionExample.md +++ b/docs/api/interfaces/ActionExample.md @@ -2,7 +2,7 @@ # Interface: ActionExample -Example content with associated user for demonstration purposes +Example content with the associated user for demonstration purposes ## Properties From cebb257150452a68ac0b3392cbb2fd2c0ef4e3c3 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Wed, 8 Jan 2025 23:58:37 +0200 Subject: [PATCH 06/11] Update ConversationExample.md --- docs/api/interfaces/ConversationExample.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/interfaces/ConversationExample.md b/docs/api/interfaces/ConversationExample.md index f38698040c7..1bebe9cfeb5 100644 --- a/docs/api/interfaces/ConversationExample.md +++ b/docs/api/interfaces/ConversationExample.md @@ -10,7 +10,7 @@ Example conversation content with user ID > **userId**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\` -UUID of user in conversation +UUID of the user in conversation #### Defined in From 95a219bcb8acb1784741f59ba8ae3acea3c519f0 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Fri, 10 Jan 2025 11:32:18 +0200 Subject: [PATCH 07/11] Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 3b1791b8264..b228e0163df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -182,7 +182,7 @@ To create new tests, add a `.test.ts` file adjacent to the code you're testing. ## Docs Updates -Please make sure to vetify if the documentation provided is correct. In order to do so, please run the docs service. +Please make sure to verify if the documentation provided is correct. In order to do so, please run the docs service. ```console docker compose -f docker-compose-docs.yaml up --build From 459732ffe62adb612df3abd8705335065eb88806 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Fri, 10 Jan 2025 11:37:58 +0200 Subject: [PATCH 08/11] Update faq.md --- docs/docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 5e0baea5660..0f26446fe2b 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -68,4 +68,4 @@ There are several ways to contribute to the Eliza project: - **Participate in community discussions**: Share your memecoin insights, propose new ideas, and engage with other community members. - **Contribute to the development of the Eliza platform**: https://github.com/orgs/elizaos/projects/1/views/3 -- **Help build the Eliza ecosystem**: Create applicatoins / tools, resources, and memes. Give feedback, and spread the word +- **Help build the Eliza ecosystem**: Create applications / tools, resources, and memes. Give feedback, and spread the word From f012581625625c39c7d8c1fe9afce4b89238acba Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:35:16 +0200 Subject: [PATCH 09/11] Update evaluators.md --- docs/docs/core/evaluators.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/core/evaluators.md b/docs/docs/core/evaluators.md index 7811e9d9531..43cfb96caa7 100644 --- a/docs/docs/core/evaluators.md +++ b/docs/docs/core/evaluators.md @@ -119,7 +119,7 @@ interface Objective { ### Handler Implementation - Use runtime services appropriately -- Store results in correct memory manager +- Store results in the correct memory manager - Handle errors gracefully - Maintain state consistency From b8831f8c0bc589b6a8ef5ce5f554696ea3915b5a Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:35:42 +0200 Subject: [PATCH 10/11] Update actions.md --- docs/docs/core/actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/core/actions.md b/docs/docs/core/actions.md index 529ff18ea3d..0f710e0c90d 100644 --- a/docs/docs/core/actions.md +++ b/docs/docs/core/actions.md @@ -179,7 +179,7 @@ const continueAction: Action = { name: "CONTINUE", similes: ["ELABORATE", "KEEP_TALKING"], description: - "Used when the message requires a follow-up. Don't use when conversation is finished.", + "Used when the message requires a follow-up. Don't use when the conversation is finished.", validate: async (runtime, message) => { // Validation logic return true; From ffa9aff300d4c55cf163b7d1ff32c54e676b1f56 Mon Sep 17 00:00:00 2001 From: itsasecret <87604944+tudorpintea999@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:36:08 +0200 Subject: [PATCH 11/11] Update characterfile.md --- docs/docs/core/characterfile.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/core/characterfile.md b/docs/docs/core/characterfile.md index f9ca0648fc3..8b5a278f459 100644 --- a/docs/docs/core/characterfile.md +++ b/docs/docs/core/characterfile.md @@ -140,7 +140,7 @@ Array used for Retrieval Augmented Generation (RAG), containing facts or referen #### `messageExamples` -Sample conversations for establishing interaction patterns, helps establish the character's conversational style. +Sample conversations for establishing interaction patterns, help establish the character's conversational style. ```json "messageExamples": [ @@ -191,7 +191,7 @@ The `style` object defines behavior patterns across contexts: ### Adjectives Array - Words that describe the character's traits and personality -- Used for generating responses with consistent tone +- Used for generating responses with a consistent tone - Can be used in "Mad Libs" style content generation ### Settings Configuration