Merge pull request #2138 from tudorpintea999/text-fixes

Docs improvements
elizaOS · Jan 10, 2025 · bcad0c4 · bcad0c4
2 parents c9d4411 + 278ac1b
commit bcad0c4
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 13 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -176,7 +176,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

diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md
@@ -194,7 +194,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\}\`
 
@@ -300,7 +300,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
 

diff --git 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` | `Function`
 

diff --git 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
 

diff --git 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
 

diff --git 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
 

diff --git 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
 

diff --git 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;

diff --git 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

diff --git 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
 

diff --git 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