Skip to content

Commit 27d70d5

Browse files
nnsW3wtfsayo
authored andcommitted
chore(spelling-fixes): docs (elizaOS#2669)
* Update DatabaseAdapter.md * Update composeContext.md * Update verified-inference.md * Update README.md --------- Co-authored-by: Sayo <hi@sayo.wtf>
1 parent 6a75089 commit 27d70d5

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ pnpm clean
100100

101101
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
102102

103-
Open another terminal, move to same directory, run the command below, then follow the URL to chat with your agent.
103+
Open another terminal, move to the same directory, run the command below, then follow the URL to chat with your agent.
104104

105105
```bash
106106
pnpm start:client

docs/api/classes/DatabaseAdapter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ like accounts, memories, actors, goals, and rooms.
1919

2020
> **new DatabaseAdapter**\<`DB`\>(`circuitBreakerConfig`?): [`DatabaseAdapter`](DatabaseAdapter.md)\<`DB`\>
2121
22-
Creates a new DatabaseAdapter instance with optional circuit breaker configuration.
22+
Creates a new DatabaseAdapter instance with an optional circuit breaker configuration.
2323

2424
#### Parameters
2525

@@ -69,7 +69,7 @@ The database instance.
6969

7070
> `protected` **circuitBreaker**: `CircuitBreaker`
7171
72-
Circuit breaker instance used to handle fault tolerance and prevent cascading failures.
72+
Circuit breaker instance are used to handle fault tolerance and prevent cascading failures.
7373
Implements the Circuit Breaker pattern to temporarily disable operations when a failure threshold is reached.
7474

7575
The circuit breaker has three states:

docs/api/functions/composeContext.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The state object contains values to replace the placeholders in the template.
2424

2525
**params.template**: `string` | `Function`
2626

27-
The template string or function returning a string containing placeholders to be replaced with state values.
27+
The template string or function returns a string containing placeholders to be replaced with state values.
2828

2929
**params.templatingEngine?**: `"handlebars"`
3030

@@ -34,7 +34,7 @@ The templating engine to use for compiling and evaluating the template (optional
3434

3535
`string`
3636

37-
The composed context string with placeholders replaced by corresponding state values.
37+
The composed context string with placeholders is replaced by corresponding state values.
3838

3939
## Example
4040

docs/docs/advanced/verified-inference.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ sidebar_position: 18
66

77
## Overview
88

9-
With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent.
9+
With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI-compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent.
1010

1111
Compared to [fully deploying the agent in a TEE](https://elizaos.github.io/eliza/docs/advanced/eliza-in-tee/), this is a more light-weight solution which only verifies the inference calls and only needs a single line of code change.
1212

1313
The API supports all OpenAI models out of the box, including your fine-tuned models. The following guide will walk you through how to use verified inference API with Eliza.
1414

1515
## Background
1616

17-
The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users.
17+
The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies the agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users.
1818

1919
Here’s how it works:
2020
![](https://i.imgur.com/SNwSHam.png)
@@ -23,7 +23,7 @@ Here’s how it works:
2323
2. The TEE securely processes the request by calling the LLM API.
2424
3. The TEE sends back the `{Message, Proof}` to the agent.
2525
4. The TEE submits the attestation with `{Message, Proof}` to Solana.
26-
5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent website/app.
26+
5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent's website/app.
2727

2828
To verify the code running inside the TEE, use instructions [from here](https://github.com/galadriel-ai/sentience/tree/main/verified-inference/verify).
2929

@@ -48,7 +48,7 @@ To verify the code running inside the TEE, use instructions [from here](https://
4848
```
4949
4. **Run your agent.**
5050

51-
Reminder how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent).
51+
Reminder of how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent).
5252
```bash
5353
pnpm start --character="characters/<your_character>.json"
5454
pnpm start:client

0 commit comments

Comments
 (0)