Skip to content

Commit 8cc05b0

Browse files
authored
Fix/edit docs duplication and typos (#44)
1 parent c4f6ef6 commit 8cc05b0

File tree

5 files changed

+3
-15
lines changed

5 files changed

+3
-15
lines changed

docs/src/docs/core/performance.md

-7
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,6 @@ async function analyticsEffect(context: RequestContext, response: MessageRespons
3232

3333
## Measures vs Marks
3434

35-
This concept comes from [Web Performance API](https://developer.mozilla.org/en-US/docs/Web/API/Performance).
36-
Marks are just named 'sequences' for the performance tool to measure.
37-
Let's say that you have a tool for your AI, and you'd like to check how it performs.
38-
Issue might be that it's being triggered multiple times by AI. For that reason
39-
one mark can be a part of multiple measures.
40-
Single measure is constructed of two marks: `start` and `end`.
41-
4235
This concept is inspired by the [Web Performance API](https://developer.mozilla.org/en-US/docs/Web/API/Performance). Marks are essentially named sequences that the performance tool uses to measure execution time. For instance, if you have a tool for your AI and want to evaluate its performance, you might find it triggered multiple times by the AI. Therefore, a single mark can be part of multiple measures. A measure is constructed using two marks: `start` and `end`.
4336

4437
:::info

docs/src/docs/core/plugins.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The order of plugins is important! Depending on the call to `next`, they are exe
8484
- Top-down before the call to `next`
8585
- Bottom-up after the call to `next`
8686

87-
## Midleware early return
87+
## Middleware early return
8888

8989
Your middleware can also break the execution chain early, stopping the execution of any subsequent middleware.
9090

docs/src/docs/core/references.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ When a tool call is triggered, you can add references to the context and later u
77
References are not automatically added for the AI. You need to implement this functionality if needed.
88
:::
99

10-
Let's create middleware that adds relevant weather information to the context.
10+
Let's create a tool that adds relevant weather information to the context.
1111

1212
```js
1313
async function queryWeather(

docs/src/docs/core/tools.md

-5
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,10 @@ OpenAI has implemented tools, but not all AI providers do.
1010

1111
## Adding tools
1212

13-
First lets start by implementing the tool function. There are two inputs for it `params` that are decided
14-
by the AI and context that is passed by byorg. Tool function has to return a string, as the information
15-
returned by it will be then passed back to AI as an 'addition' to system prompt.
16-
1713
To start, implement the tool function. It takes two inputs: `params`, which are determined by the AI, and `context`, which is passed by byorg.
1814
The tool function must return a string, as this information will be passed back to the AI as an addition to the system prompt.
1915

2016
```js
21-
2217
async function queryUsers(params: { query: string }, context: RequestContext): Promise<string> {
2318
const { query } = params;
2419
const { references } = context;

docs/src/docs/core/usage.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ Here is step by step how to start with byorg.
4646

4747
{/* prettier-ignore-end */}
4848

49-
That's it! Your message is being handled an processed by byorg.
49+
That's it! Your message is being handled and processed by byorg.
5050

5151
In next sections we will go through customisation, error handling and changing LLM provider, to better suit your needs.

0 commit comments

Comments
 (0)