Skip to content

Fix typos #206

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion src/concepts/how-it-works.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How ao messaging works

Before we dive in to ao, I want to share with you a little information about unix. Unix is a powerful operating system, but in its design it is focused on two Principal "Types". Files and Programs. A File is data and a program is logic, when you combine the two you get information.
Before we dive in to ao, I want to share with you a little information about Unix. Unix is a powerful operating system, but in its design it is focused on two Principal "Types". Files and Programs. A File is data and a program is logic, when you combine the two you get information.

`Input.file | TransformProgram | Output.file`

Expand Down
4 changes: 2 additions & 2 deletions src/concepts/lua.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Before we can explore ao in greater depth, let's take a moment to learn the basics of Lua: your companion for commanding aos processes.

Lua is a simple language with few surprises. If you know Javascript, it will feel like a simplified, purer version. If you are learning from-scratch, it will seem like a tiny language that focuses on the important stuff: Clean computation with sane syntax.
Lua is a simple language with few surprises. If you know JavaScript, it will feel like a simplified, purer version. If you are learning from-scratch, it will seem like a tiny language that focuses on the important stuff: Clean computation with sane syntax.

In this section we will cover the basics of Lua in just a few minutes. If you already know Lua, jump right through to the [next chapter]()

## Jumping back into your aos process.

For the purpose of this tutorial, we will be assuming that you have already completed the [getting started](/welcome/getting-started) guide. If not, complete that first.

If you logged out of your process, you can always re-open it by running `aos` on your commandline, optionally specifying your key file with `--wallet [location]`.
If you logged out of your process, you can always re-open it by running `aos` on your command-line, optionally specifying your key file with `--wallet [location]`.

## Basic Lua expressions.

Expand Down
2 changes: 1 addition & 1 deletion src/concepts/specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

The `ao` computer is the [actor oriented](https://en.wikipedia.org/wiki/Actor_model) machine that emerges from the network of nodes that adhere to its core data protocol, running on the [Arweave](https://arweave.org) network. This document gives a brief introduction to the protocol and its functionality, as well as its technical details, such that builders can create new implementations and services that integrate with it.

The `ao` computer is a single, unified computing environment (a [Single System Image](https://en.wikipedia.org/wiki/Single_system_image)), hosted on a heterogenous set of nodes in a distributed network. `ao` is designed to offer an environment in which an arbitrary number of parallel processes can be resident, coordinating through an open message passing layer. This message passing standard connects the machine's indepedently operating processes together into a 'web' -- in the same way that websites operate on independent servers but are conjoined into a cohesive, unified experience via hyperlinks.
The `ao` computer is a single, unified computing environment (a [Single System Image](https://en.wikipedia.org/wiki/Single_system_image)), hosted on a heterogeneous set of nodes in a distributed network. `ao` is designed to offer an environment in which an arbitrary number of parallel processes can be resident, coordinating through an open message passing layer. This message passing standard connects the machine's independently operating processes together into a 'web' -- in the same way that websites operate on independent servers but are conjoined into a cohesive, unified experience via hyperlinks.

[Learn More](https://ao.g8way.io/#/spec)
4 changes: 2 additions & 2 deletions src/guides/aoconnect/aoconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ next:

# aoconnect

ao connect is a Javascript/Typescript library to interact with the system from Node JS or the browser.
ao connect is a JavaScript/TypeScript library to interact with the system from Node JS or the browser.

Guides in this section provide snippets on how to utilize ao connect. All snippets are written in Javascript but should translate easily to Typescript.
Guides in this section provide snippets on how to utilize ao connect. All snippets are written in JavaScript but should translate easily to Typescript.
2 changes: 1 addition & 1 deletion src/guides/aoconnect/connecting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connecting to specific ao nodes

When including ao connect in your code you have the ability to connect to a specific MU and CU, as well as being able to specifiy an Arweave gateway. This can be done by importing the "connect" function and extracting the functions from a call to the "connect" function.
When including ao connect in your code you have the ability to connect to a specific MU and CU, as well as being able to specify an Arweave gateway. This can be done by importing the "connect" function and extracting the functions from a call to the "connect" function.

You may want to do this if you want to know which MU is being called when you send your message so that later you can debug from the specified MU. You also may want to read a result from a specific CU. You may in fact just prefer a particular MU and CU for a different reason. You can specify the gateway in order to use something other than the default, which is arweave.net.

Expand Down
2 changes: 1 addition & 1 deletion src/guides/aoconnect/monitoring-cron.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monitoring Cron

When using cron messages, ao users need a way to start injesting the messages, using this monitor method, ao users can initiate the subscription service for cron messages. Setting cron tags means that your process will start producing cron results in its outbox, but you need to monitor these results if you want messages from those results to be pushed through the network.
When using cron messages, ao users need a way to start ingesting the messages, using this monitor method, ao users can initiate the subscription service for cron messages. Setting cron tags means that your process will start producing cron results in its outbox, but you need to monitor these results if you want messages from those results to be pushed through the network.

```js
import { readFileSync } from "node:fs";
Expand Down
4 changes: 2 additions & 2 deletions src/guides/aos/editor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Editor setup

Remembering all the built in ao functions and utilites can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../aos/modules/index) and [globals](../aos/intro#globals).
Remembering all the built in ao functions and utilities can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../aos/modules/index) and [globals](../aos/intro#globals).

## VS Code

Expand All @@ -14,7 +14,7 @@ Install the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=su
> Lua: Open Addon Manager
```

4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autcomplete!
4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autocomplete!

## Other editors

Expand Down
4 changes: 2 additions & 2 deletions src/guides/aos/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ the `Inbox` is a collection of messages that your Process has received.
Inbox[1]
```

If you want to get a count of messages, just add the `#` infront of `Inbox`.
If you want to get a count of messages, just add the `#` in front of `Inbox`.

```lua
#Inbox
Expand Down Expand Up @@ -60,7 +60,7 @@ In aos process there are some Globals that can make development a little more in
| Handlers | a lua Table that contains helper functions that allows you to create handlers that execute functionality based on the pattern matching function on inbound messages | table |
| Dump | a function that takes any lua Table and generates a print friendly output of the data | function |
| Utils | a functional utility library with functions like map, reduce, filter | module |
| ao | this is a core function library for sending messages and spawing processes | module |
| ao | this is a core function library for sending messages and spawning processes | module |

## Modules

Expand Down
2 changes: 1 addition & 1 deletion src/guides/aos/modules/ao.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ao.send({

### `ao.env`

The `ao.env` global variable holds informationg about the initializing message of the process. It follows the schema below:
The `ao.env` global variable holds information about the initializing message of the process. It follows the schema below:

```json
{
Expand Down
6 changes: 3 additions & 3 deletions src/references/ao.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,14 @@ Schema

### spawn(module : string, spawn : Spawn\<table>) : Spawn\<table>

The `spawn` function takes a module TXID as the first argument and a full or parital Spawn table. The result will return a full Spawn table. The spawn function will also generate a `Ref_` tag with a unique reference identifier.
The `spawn` function takes a module TXID as the first argument and a full or partial Spawn table. The result will return a full Spawn table. The spawn function will also generate a `Ref_` tag with a unique reference identifier.

**parameters**

| Name | Description | Type |
| ------ | --------------------------------------------------------------------------------------- | ------ |
| module | The TXID that identifies the module binary to use to instaniate the process with | string |
| spawn | The `spawn` full or parital table object that contains the `Data` and `Tags` properties | table |
| module | The TXID that identifies the module binary to use to instantiate the process with | string |
| spawn | The `spawn` full or partial table object that contains the `Data` and `Tags` properties | table |

Schema

Expand Down
2 changes: 1 addition & 1 deletion src/references/cron.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cron Messages

ao has the ability to generate messages on a specified interval, this interval could be seconds, minutes, hours, or blocks. These messages automatically get evaluated by a monitoring process to inform the Process to evalute these messages over time. The result is a real-time Process that can communicate with the full ao network or oracles in the outside network.
ao has the ability to generate messages on a specified interval, this interval could be seconds, minutes, hours, or blocks. These messages automatically get evaluated by a monitoring process to inform the Process to evaluate these messages over time. The result is a real-time Process that can communicate with the full ao network or oracles in the outside network.

## Setting up cron in a process

Expand Down
4 changes: 2 additions & 2 deletions src/references/data.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Accessing Data from Arweave with ao

There may be times in your ao development workflow that you want to access data from arweave. With ao your process can send an assignment instructing the network to provide that data to your Process.
There may be times in your ao development workflow that you want to access data from Arweave. With ao your process can send an assignment instructing the network to provide that data to your Process.

In order, to request data from arweave, you simply call Assign with a list of processes you would like to assign the data to, and a Message which is the txid of a Message.
In order, to request data from Arweave, you simply call Assign with a list of processes you would like to assign the data to, and a Message which is the txid of a Message.

```lua

Expand Down
2 changes: 1 addition & 1 deletion src/references/editor-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Editor setup

Remembering all the built in ao functions and utilites can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../guides/aos/index.md) and [globals](../guides/aos/intro#globals).
Remembering all the built in ao functions and utilities can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../guides/aos/index.md) and [globals](../guides/aos/intro#globals).

## VS Code

Expand Down
6 changes: 3 additions & 3 deletions src/references/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Status:** DRAFT-1
**Targeting Network:** ao.TN.1

This specification describes the necessary message handlers and functionality required for a standard ao token process. Implementations of this standard typically offer users the ability to control a transferrable asset, whose scarcity is maintained by the process.
This specification describes the necessary message handlers and functionality required for a standard ao token process. Implementations of this standard typically offer users the ability to control a transferable asset, whose scarcity is maintained by the process.

Each compliant process will likely implement a ledger of balances in order to encode ownership of the asset that the process represents. Compliant processes have a set of methods that allow for the modification of this ledger, typically with safe-guards to ensure the scarcity of ownership of the token represented by the process.

Expand All @@ -15,7 +15,7 @@ A specification-compliant token process responds to a number of different forms

| Name | Description | Read-Only |
| -------- | ------------------------------------------------------------------------------------------------------ | ------------------ |
| Balance | get the balance of an identifer | :heavy_check_mark: |
| Balance | get the balance of an identifier | :heavy_check_mark: |
| Balances | get a list of all ledger/account balances | :heavy_check_mark: |
| Transfer | send 1 or more units from the callers balance to one or move targets with the option to notify targets | :x: |
| Mint | if the ledger process is the root and you would like to increase token supply | :x: |
Expand All @@ -30,7 +30,7 @@ Every compliant token process must carry the following immutable parameters upon
| ------------ | --------------------------------------------------------------------------------------------------------------------- | ------------------ |
| Name | The title of the token, as it should be displayed to users. | :heavy_check_mark: |
| Ticker | A suggested shortened name for the token, such that it can be referenced quickly. | :heavy_check_mark: |
| Logo | An image that applications may deserire to show next to the token, in order to make it quickly visually identifiable. | :heavy_check_mark: |
| Logo | An image that applications may desire to show next to the token, in order to make it quickly visually identifiable. | :heavy_check_mark: |
| Denomination | The number of the token that should be treated as a single unit when quantities and balances are displayed to users. | :x: |

## Messaging Protocol
Expand Down
4 changes: 2 additions & 2 deletions src/tutorials/begin/dao.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide brings you through the process of building a DAO using aos. If you have not already, you will need to first build a [token](./token.md) in aos. We will load the DAO code into aos alongside the token code from the [token](./token.md) guide. In the context of ao a DAO may be used to govern MU, CU, and SU nodes.

In our DAO we will implement a process knwon as "slashing". In the case of ao, if a unit is misbehaving, other units may vote to slash them. Slashing means they will lose their stake, we will get more into stake later.
In our DAO we will implement a process known as "slashing". In the case of ao, if a unit is misbehaving, other units may vote to slash them. Slashing means they will lose their stake, we will get more into stake later.

Make a new directory called `dao` and copy in the token.lua created in the token guide.

Expand Down Expand Up @@ -153,7 +153,7 @@ Handlers.add("finalize", function (msg) return -1 end, finalizationHandler)

## Loading and Testing

Now that we have dao.lua complete we can load it into aos alongside token.lua from the [token](./token.md) guide. Run a new aos Proces called `dao` while also loading dao.lua and token.lua
Now that we have dao.lua complete we can load it into aos alongside token.lua from the [token](./token.md) guide. Run a new aos Process called `dao` while also loading dao.lua and token.lua

```sh
aos dao --load token.lua --load dao.lua
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/begin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ next:

# Begin: An Interactive Tutorial

In this tutorial series, you'll walk through an interactive steps that will help you deepen your knowledge and understanding of the aos environment.
In this tutorial series, you'll walk through interactive steps that will help you deepen your knowledge and understanding of the aos environment.

::: info

Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/begin/preparations.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ If your OS version is different than the latest version, a message asking if you

Welcome to your new home in the ao computer! The prompt you are now looking at is your own personal server in this decentralized machine.

Now, let's journey further down the rabbit hole by exploring one of the two core concept type of ao: [messaging](messaging).
Now, let's journey further down the rabbit hole by exploring one of the two core concept types of ao: [messaging](messaging).
2 changes: 1 addition & 1 deletion src/tutorials/begin/tokengating.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Good luck.
-Trinity". Additionally, a footer will follow the message.

::: warning
Read the footer on Trinity's message carefully to find out how to submit your claim and recieve your CRED.
Read the footer on Trinity's message carefully to find out how to submit your claim and receive your CRED.
:::

## Conclusion
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/bots-and-games/arena-mechanics.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ Handlers.add(

## Arena Game Blueprint

For those interested in using this arena framework, we've made this code easily accesible through a blueprint. Simply run the following code in your terminal:
For those interested in using this arena framework, we've made this code easily accessible through a blueprint. Simply run the following code in your terminal:

```lua
.load-blueprint arena
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/bots-and-games/game-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Let's define a new variable that stores the latest state as follows:
LatestGameState = LatestGameState or nil
```

The syntax preserves exisitng values of the variable when you load successive iterations of the `bot.lua` file in your terminal, instead of overwriting it. If there is no pre-existing value then a `nil` value is assigned to the variable.
The syntax preserves existing values of the variable when you load successive iterations of the `bot.lua` file in your terminal, instead of overwriting it. If there is no pre-existing value then a `nil` value is assigned to the variable.

Then implement another handler as follows:

Expand Down
Loading