diff --git a/docusaurus/docs/README.md b/docusaurus/docs/README.md index f226dc1d4..1de7ee4d7 100644 --- a/docusaurus/docs/README.md +++ b/docusaurus/docs/README.md @@ -57,7 +57,7 @@ You can view the Shannon Roadmap on [Github](https://github.com/orgs/pokt-networ ## Quickstart -The best way to get involved is by following the [quickstart instructions](./develop/developer_guide/quickstart.md). +The best way to get involved is by following the [quickstart instructions](develop/developer_guide/walkthrough.md). ## Godoc diff --git a/docusaurus/docs/develop/contributing/code_review_guidelines.md b/docusaurus/docs/develop/contributing/code_review_guidelines.md index 287b5d5d7..41f892a97 100644 --- a/docusaurus/docs/develop/contributing/code_review_guidelines.md +++ b/docusaurus/docs/develop/contributing/code_review_guidelines.md @@ -3,7 +3,7 @@ sidebar_position: 3 title: Code Review Guidelines --- -# Code Review Guidelines +## Code Review Guidelines :::note This is a living document and will be updated as the ecosystem matures & grows. diff --git a/docusaurus/docs/develop/developer_guide/quickstart.md b/docusaurus/docs/develop/developer_guide/walkthrough.md similarity index 99% rename from docusaurus/docs/develop/developer_guide/quickstart.md rename to docusaurus/docs/develop/developer_guide/walkthrough.md index a899fba64..da5f30ed3 100644 --- a/docusaurus/docs/develop/developer_guide/quickstart.md +++ b/docusaurus/docs/develop/developer_guide/walkthrough.md @@ -1,11 +1,11 @@ --- sidebar_position: 1 -title: Quickstart +title: Walkthrough --- import ReactPlayer from "react-player"; -# Quickstart +## Walkthrough :::info The goal of this document is to get you up and running with a LocalNet, some diff --git a/docusaurus/docs/operate/configs/supplier_staking_config.md b/docusaurus/docs/operate/configs/supplier_staking_config.md index 169221639..41ba22758 100644 --- a/docusaurus/docs/operate/configs/supplier_staking_config.md +++ b/docusaurus/docs/operate/configs/supplier_staking_config.md @@ -214,8 +214,8 @@ _`Optional`_, _`Non-empty`_ ```yaml default_rev_share_percent: - : - : + : + : ``` `default_rev_share_percent` is an optional map that defines the default the revenue diff --git a/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md b/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md index 40e008fd1..6123e5ce8 100644 --- a/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md +++ b/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md @@ -132,7 +132,7 @@ Make sure to replace `olshansky` with your username. You can generally do everything as the `root` user, but it's recommended to create a new user and give it sudo permissions. -This is necessary, in particular, if you want to use [homebrew](https://brew.sh/) [to install `poktrolld`](../user_guide/install.md). +This is necessary, in particular, if you want to use [homebrew](https://brew.sh/) [to install `poktrolld`](../user_guide/poktrolld_cli.md). ```bash adduser poktroll @@ -190,7 +190,7 @@ sed -i -e s/NODE_HOSTNAME=/NODE_HOSTNAME=69.42.690.420/g .env You can generally do everything as the `root` user, but it's recommended to create a new user and give it sudo permissions. -This is necessary, in particular, if you want to use [homebrew](https://brew.sh/) [to install `poktrolld`](../user_guide/install.md). +This is necessary, in particular, if you want to use [homebrew](https://brew.sh/) [to install `poktrolld`](../user_guide/poktrolld_cli.md). You can create a new user (e.g. poktroll), provide sudo permissions and switch users like so: diff --git a/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md b/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md index 741966d13..861c2b06a 100644 --- a/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md +++ b/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md @@ -38,7 +38,7 @@ streamline development and reduce friction for any new potential contributor. ## Pre-Requisites -1. Make sure to [install the `poktrolld` CLI](../user_guide/install.md). +1. Make sure to [install the `poktrolld` CLI](../user_guide/poktrolld_cli.md). 2. Make sure you know how to [create and fund a new account](../user_guide/create-new-wallet.md). :::warning diff --git a/docusaurus/docs/operate/quickstart/service_cheatsheet.md b/docusaurus/docs/operate/quickstart/service_cheatsheet.md index 4e3304db5..eda5d4af5 100644 --- a/docusaurus/docs/operate/quickstart/service_cheatsheet.md +++ b/docusaurus/docs/operate/quickstart/service_cheatsheet.md @@ -14,7 +14,7 @@ title: Service Cheat Sheet ### Pre-Requisites -1. Make sure to [install the `poktrolld` CLI](../user_guide/install.md). +1. Make sure to [install the `poktrolld` CLI](../user_guide/poktrolld_cli.md). 2. Make sure you know how to [create and fund a new account](../user_guide/create-new-wallet.md). ### How do I query for all existing onchain Services? diff --git a/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md b/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md index 1bc9eed64..32446be7a 100644 --- a/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md +++ b/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md @@ -39,7 +39,7 @@ streamline development and reduce friction for any new potential contributor. ## Pre-Requisites -1. Make sure to [install the `poktrolld` CLI](../user_guide/install.md). +1. Make sure to [install the `poktrolld` CLI](../user_guide/poktrolld_cli.md). 2. Make sure you know how to [create and fund a new account](../user_guide/create-new-wallet.md). 3. You have either [staked a new `service` or found an existing one](./service_cheatsheet.md). 4. `[Optional]` You can run things locally or have dedicated long-running hardware. See the [Docker Compose Cheat Sheet](./docker_compose_debian_cheatsheet#deploy-your-server) if you're interested in the latter. @@ -277,5 +277,5 @@ poktrolld query supplier -h Then, you can query for all services like so: ```bash -poktrolld query supplier list-supplier --node https://shannon-testnet-grove-rpc.beta.poktroll.com --output json | jq +poktrolld query supplier list-suppliers --node https://shannon-testnet-grove-rpc.beta.poktroll.com --output json | jq ``` diff --git a/docusaurus/docs/operate/run_a_node/full_node_walkthrough.md b/docusaurus/docs/operate/run_a_node/full_node_walkthrough.md index 2a19269fb..44ab1e221 100644 --- a/docusaurus/docs/operate/run_a_node/full_node_walkthrough.md +++ b/docusaurus/docs/operate/run_a_node/full_node_walkthrough.md @@ -130,7 +130,7 @@ source ~/.profile ### 5. Install `poktrolld` -Follow the instructions in the [CLI Installation Guide](../user_guide/install.md) page to install `poktrolld`. +Follow the instructions in the [CLI Installation Guide](../user_guide/poktrolld_cli.md) page to install `poktrolld`. Create a symlink of the binary so Comosvisor knows where to find it: diff --git a/docusaurus/docs/operate/user_guide/install.md b/docusaurus/docs/operate/user_guide/poktrolld_cli.md similarity index 98% rename from docusaurus/docs/operate/user_guide/install.md rename to docusaurus/docs/operate/user_guide/poktrolld_cli.md index dab4f98b2..9ca5431b9 100644 --- a/docusaurus/docs/operate/user_guide/install.md +++ b/docusaurus/docs/operate/user_guide/poktrolld_cli.md @@ -1,5 +1,5 @@ --- -title: CLI Installation +title: poktrolld CLI Installation sidebar_position: 0 ---