Skip to content
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

Docs improvements #297

Open
wants to merge 21 commits 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 CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Lava docs serves multiple user types in different lifecycle steps.
We want to create a doc resource that will fit all, but have a common denominator of style.

Styleguides are guidance and not a restriction, good articles we picked for this purpose are:
- When it comes to git opeartions, we recommend https://cbea.ms/git-commit/
- When it comes to git operations, we recommend https://cbea.ms/git-commit/
- When it is docs actual content, we recommend https://medium.com/larimaza-en/how-to-write-good-documentation-e19c70dc67f0

## Getting started
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Contributing to the documentation of Lava is a rewarding way to give back to the
[![Netlify Status](https://api.netlify.com/api/v1/badges/58c0a448-7af0-48d3-8e29-86fc4a6f4868/deploy-status)](https://app.netlify.com/sites/sage-swan-13ac7b/deploys)

### Process
The `main` branch of this repository is automatically deployed to our docs site, and other branches and pull requests leverage Netlify deploy. Please note that unless you are a recognized contributor of this repository, each attempted PR generates a Netlify approval that will prevent your pull request from being merged. Once the request is approved and a Netlify deploy preview is generated, a Netlify deploy preview will appear in the body of your PR as `😎 Deploy Preview`. This deploy preview will be audited by a docs maintainer before merging your pull request.
The `main` branch of this repository is automatically deployed to our docs site, and other branches and pull requests leverage Netlify deployment. Please note that unless you are a recognized contributor of this repository, each attempted PR generates a Netlify approval that will prevent your pull request from being merged. Once the request is approved and a Netlify deploy preview is generated, a Netlify deploy preview will appear in the body of your PR as `😎 Deploy Preview`. This deploy preview will be audited by a docs maintainer before merging your pull request.

## Local Development 🔧

Expand Down Expand Up @@ -95,4 +95,4 @@ If you are using GitHub pages for hosting, this command is a convenient way to b

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
```
6 changes: 3 additions & 3 deletions docs/chains/agoric-chain/agoric-node.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
slug: /agoric-node
title: Running a Agoric RPC Node
title: Running an Agoric RPC Node
---

# Running a Agoric RPC Node
# Running an Agoric RPC Node

## Requirements 📄

:::caution
Users may experience issues when attempting to run instructions using versions >= 18.19.0 of `Node.js`. Node versions >=18.19 introduce a breaking change to AgoricSDK, and are not currently supported.
:::

There are notable minimum hardware requirements in order to run a Agoric RPC Nodes:
There are notable minimum hardware requirements in order to run Agoric RPC Nodes:

16 GB RAM
4-Cores x86_64 CPU
Expand Down
6 changes: 3 additions & 3 deletions docs/chains/avalanche-chain/avalanche-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Before you start, ensure that your machine meets the following [minimum requirem

## Install AvalancheGo 🚀

AvalancheGo is a go implementation of an Avalanche node. This software is necessary to run a Avalanche RPC node.
AvalancheGo is a go implementation of an Avalanche node. This software is necessary to run an Avalanche RPC node.
AvalancheGo can be installed automatically on a local machine using a shell bash script or manually with some commands.There are detailed guides for both [automatic installation](https://docs.avax.network/nodes/build/set-up-node-with-installer) and [manual installation](https://docs.avax.network/nodes/build/run-avalanche-node-manually) available in the Avalanche docs.



### Automated Script

To do automated install using the AvalancheGo install script, input the following into a terminal:
To do an automated installation using the AvalancheGo install script, input the following into a terminal:

```bash
wget -nd -m https://raw.githubusercontent.com/ava-labs/avalanche-docs/master/scripts/avalanchego-installer.sh;\
Expand Down Expand Up @@ -90,4 +90,4 @@ In our current state of Testnet, there is an additional stage to pass through be

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-avalanche-rpc-node&utm_medium=docs&utm_campaign=avalanche-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node on the Lava Network.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-avalanche-rpc-node&utm_medium=docs&utm_campaign=avalanche-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node on the Lava Network.
4 changes: 2 additions & 2 deletions docs/chains/axelar-chain/axelar-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ OS: Ubuntu 18.04 or MacOS(x86)
## Install 📥

:::caution
Some users have reported issues with the Axelarate install script. If you encounter issues, please consider making an [issue](https://github.com/axelarnetwork/axelarate-community/issues) or trying to install manually.
Some users have reported issues with the Axelarate install script. If you encounter issues, please consider making an [issue](https://github.com/axelarnetwork/axelarate-community/issues) or trying to install it manually.
:::

Clone the Axelarate-Community Repo and then run the Node Setup Script.
Expand All @@ -64,4 +64,4 @@ Want to reach more developers and get more rewards as a node runner? Axelar pays

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-axelar-rpc-node&utm_medium=docs&utm_campaign=axelar-post-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node on the Lava Network.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-axelar-rpc-node&utm_medium=docs&utm_campaign=axelar-post-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node on the Lava Network.
8 changes: 4 additions & 4 deletions docs/chains/base-chain/base-node.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
slug: /base-node
title: Running an Base RPC Node
title: Running a Base RPC Node
---

# Running a Base RPC Node

## Requirements 📄

Before you start, be sure to install [Docker](https://www.docker.com/get-started). Once you have docker installed, you can continue onto the next step.
Before you start, be sure to install [Docker](https://www.docker.com/get-started). Once you have docker installed, you can continue to the next step.

>16 GB RAM
SSD, 2 TB free space
Expand All @@ -17,7 +17,7 @@ Before you start, be sure to install [Docker](https://www.docker.com/get-started

### 💿 Setup a L1 Full Node RPC

You need a Ethereum L1 Full Node running before you can use Base. Set `OP_NODE_L1_ETH_RPC` if you're using docker-compose.
You need an Ethereum L1 Full Node running before you can use Base. Set `OP_NODE_L1_ETH_RPC` if you're using docker-compose.

### ✨ Clone the Repo

Expand All @@ -42,4 +42,4 @@ In our current state of Testnet, there is an additional stage to pass through be

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-base-rpc-node&utm_medium=docs&utm_campaign=base-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-base-rpc-node&utm_medium=docs&utm_campaign=base-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
12 changes: 6 additions & 6 deletions docs/chains/celestia-chain/celestia-node.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
slug: /celestia-node
title: Running a celestia RPC Node
title: Running a Celestia RPC Node
---

# Running a celestia RPC Node
# Running a Celestia RPC Node

## Requirements 📄

Expand All @@ -17,8 +17,8 @@ title: Running a celestia RPC Node

## Setup celestia consensus and DA node

Follow celestia docs for instructions on how to setup and run the nodes:
Data availabillity light node https://docs.celestia.org/nodes/light-node
Follow Celestia docs for instructions on how to setup and run the nodes:
Data availability light node https://docs.celestia.org/nodes/light-node
Consensus node https://docs.celestia.org/nodes/full-consensus-node

Important note:
Expand All @@ -39,7 +39,7 @@ To set up your provider on the Lava Network, you can refer to the [provider setu

Celestia providers must supply endpoint for both consensus and DA node:
- consensus node: rest, tendermint, grpc (this is the same as every other cosmos node)
- DA node: jsonrpc (when running the light DA node the defualt port will be 26658)
- DA node: jsonrpc (when running the light DA node the default port will be 26658)


example for provider configuration file
Expand Down Expand Up @@ -74,4 +74,4 @@ endpoints:
address: 0.0.0.0:2221
node-urls:
- url: http://127.0.0.1:1317
```
```
8 changes: 4 additions & 4 deletions docs/chains/celo-chain/celo-node.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
slug: /celo-node
title: Running an Celo RPC Node
title: Running a Celo RPC Node
---

# Running a Celo RPC Node

## Requirements 📄

Before you start, be sure to install [Docker](https://www.docker.com/get-started). Once you have docker installed, you can continue onto the next step.
Before you start, be sure to install [Docker](https://www.docker.com/get-started). Once you have docker installed, you can continue to the next step.


## Install Celo Docker Image 📥

Celo's node is built from a Docker image pulled using Docker CLI. This software is necessary to run a Celo RPC node. To get started, input the following in terminal:
Celo's node is built from a Docker image pulled using Docker CLI. This software is necessary to run a Celo RPC node. To get started, input the following in the terminal:

```bash
export CELO_IMAGE=us.gcr.io/celo-org/geth:mainnet
Expand Down Expand Up @@ -45,4 +45,4 @@ In our current state of Testnet, there is an additional stage to pass through be

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-celo-rpc-node&utm_medium=docs&utm_campaign=celo-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-celo-rpc-node&utm_medium=docs&utm_campaign=celo-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
4 changes: 2 additions & 2 deletions docs/chains/ethereum-chain/ethereum-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

## Requirements 📄

Ethereum nodes have some basic hardware requirements that must be met in order to proceed with the install process:
Ethereum nodes have some basic hardware requirements that must be met in order to proceed with the installation process:

<Tabs>
<TabItem value="manual_req" label="Manual">
Expand Down Expand Up @@ -50,4 +50,4 @@ In our current state of Testnet, there is an additional stage to pass through be

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-ethereum-rpc-node&utm_medium=docs&utm_campaign=ethereum-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-ethereum-rpc-node&utm_medium=docs&utm_campaign=ethereum-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
6 changes: 3 additions & 3 deletions docs/chains/filecoin-chain/filecoin-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The list above is specific to Debian/Ubuntu-based OSes. For a different configur

## Install Lotus Filecoin Node 🚀

Filecoin is a divers ecosystem with different node implementations. Each node implementation has different ways to generate and manage authentication tokens. This guide uses [Lotus Filecoin](https://lotus.filecoin.io/lotus/get-started/what-is-lotus/), which is the reference node implementation for the Filecoin network.
Filecoin is a diverse ecosystem with different node implementations. Each node implementation has different ways to generate and manage authentication tokens. This guide uses [Lotus Filecoin](https://lotus.filecoin.io/lotus/get-started/what-is-lotus/), which is the reference node implementation for the Filecoin network.

### Get Lotus
To get started, input the following into the terminal:
Expand All @@ -47,7 +47,7 @@ make clean calibnet # Calibration with min 32GiB sectors
```

### Compile Lotus
Finalize the install by inputting `sudo make install` in the terminal.
Finalize the installation by inputting `sudo make install` in the terminal.
You can run `lotus --version` to ensure that this process completed successfully.

:::tip
Expand Down Expand Up @@ -99,4 +99,4 @@ In our current state of Testnet, there is an additional stage to pass through be

## Setup your Provider on Lava Network 🌋

Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-filecoin-rpc-node&utm_medium=docs&utm_campaign=filecoin-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
Once you’ve been accepted - to set up your provider on the Lava Network, you can refer to the [provider setup documentation](https://docs.lavanet.xyz/provider-setup?utm_source=running-a-filecoin-rpc-node&utm_medium=docs&utm_campaign=filecoin-pre-grant) available elsewhere in our docs. This should provide you with the necessary information to configure and operate your provider node.
2 changes: 1 addition & 1 deletion docs/chains/koii-chain/koii-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ koii-validator \

### 🧪 Test Your Endpoints

There maybe additional configurations necessary to complete your setup.
There may be additional configurations necessary to complete your setup.
You should consult the [Validator setup guide](https://docs.koii.network/run-a-node/k2-validators/validator-setup) for Koii and the [RPC Setup Guide](https://docs.solana.com/validator/get-started/setup-an-rpc-node) for Solana to ensure you've covered all necessary steps.


Expand Down
2 changes: 1 addition & 1 deletion docs/chains/near-chain/near-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ make release
```

:::caution
`make release` will cause the `nearcore` to compile. Compilation is a time-intensive process and can take ~30 minutes or longer on recommmended hardware.
`make release` will cause the `nearcore` to compile. Compilation is a time-intensive process and can take ~30 minutes or longer on recommended hardware.
:::

### Configure the release folder
Expand Down
6 changes: 3 additions & 3 deletions docs/developer/sdk/sdk-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ title: Backend Use 🛡️

## ↪️ Recommended Flow

Although you can subscribe your private key from the commandline, the easiest way to get started is through Lava's Gateway.
Although you can subscribe your private key from the command line, the easiest way to get started is through Lava's Gateway.
1. Sign up to the Gateway. 👉🏿[Register now](https://gateway.lavanet.xyz/?utm_source=sdk-backend-page&utm_medium=docs&utm_campaign=docs-to-gateway) if you haven’t already!

2. Create a Project and Select your APIs!
Expand All @@ -45,6 +45,6 @@ If you already have `lavad` installed - you can easily generate a lava address b

<iframe width="100%" height="480" src="/img/tutorial/sdk/adding_lava_key.mp4" frameborder="0" allow="autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

If you have an address that exists and no longer remember its private key, you can alwasy use `lavad keys export <key-name> --unarmored-hex --unsafe` to see your privatekey printed as a string. Do not share the output with anyone!
If you have an address that exists and no longer remembers its private key, you can always use `lavad keys export <key-name> --unarmored-hex --unsafe` to see your privatekey printed as a string. Do not share the output with anyone!

🚀 Your private-key, public-key pair can be used for backend development provided you have a subscription!
🚀 Your private-key, public-key pair can be used for backend development provided you have a subscription!
2 changes: 1 addition & 1 deletion docs/intro/key-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ title: 📝 Key Terms

<details>
<summary>Badges</summary>
Special permissions required for end-users to send relays when connecting to the Lava Network from frontend applications, generated by Dapp owners using a subscription private key.
Special permissions are required for end-users to send relays when connecting to the Lava Network from frontend applications, generated by Dapp owners using a subscription private key.
</details>

<details>
Expand Down
4 changes: 2 additions & 2 deletions docs/intro/specs/spec-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ This field defines the number of blocks that should be considered safe from chai

<details><summary> `blocks_in_finalization_proof` </summary>

This field defines the number of blocks that should be found in a finality proof; this will vary from chain to chain. Look to other similarly architected specs fo suggested values.
This field defines the number of blocks that should be found in a finality proof; this will vary from chain to chain. Look to other similarly architected specs for suggested values.

</details>

Expand All @@ -152,7 +152,7 @@ This is the maximum amount of blocks that can pass before the data a provider se

<details><summary> `shares` </summary>

The default is `1`. This is a bonus multiplier for rewards at the end of each month. There should be no reason to change this unless diected otherwise.
The default is `1`. This is a bonus multiplier for rewards at the end of each month. There should be no reason to change this unless directed otherwise.

</details>

Expand Down
2 changes: 1 addition & 1 deletion docs/lava-blockchain/hardware-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Hardware requirements
- Shared compute instance (e.g. AWS EC2 instance)
- Your personal station

**Docker** container are available at [Lava's repository on GitHub](https://github.com/lavanet/lava/tree/main/docker)
**Docker** containers are available at [Lava's repository on GitHub](https://github.com/lavanet/lava/tree/main/docker)

## Hardware requirements

Expand Down
4 changes: 2 additions & 2 deletions docs/provider/lavavisor/lavavisor-wrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Please make sure you are using the right `chainId` this document was written dur

### > `lavavisor init`
LavaVisor `init` command initializes the environment for LavaVisor. It is generally the first command run when using LavaVisor.
If you're using [`lavavisor pod`](#-lavavisor-pod) this command is unnecesary and can be skipped.
If you're using [`lavavisor pod`](#-lavavisor-pod) this command is unnecessary and can be skipped.

**Optional Flags:**

Expand Down Expand Up @@ -98,4 +98,4 @@ Lavavisor doesn't check if the password is correct; it will try to use it when s

```bash
lavavisor wrap --cmd 'lavap rpcprovider ./config/my_rpcprovider_config.yml --geolocation 1 --log_level debug --from prod_client --chain-id lava-testnet-2 --keyring-backend os --node "<local/public node url>"' --auto-download --node "<local/public node url>" --chain-id lava-testnet-2 --enter-keyring-password
```
```
Loading