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

Minor doc NITs #1029

Closed
wants to merge 15 commits into from
2 changes: 1 addition & 1 deletion docusaurus/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 3
title: Code Review Guidelines
---

# Code Review Guidelines <!-- omit in toc -->
## Code Review Guidelines <!-- omit in toc -->

:::note
This is a living document and will be updated as the ecosystem matures & grows.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_position: 1
title: Quickstart
title: Walkthrough
---

import ReactPlayer from "react-player";

# Quickstart <!-- omit in toc -->
## Walkthrough <!-- omit in toc -->

:::info
The goal of this document is to get you up and running with a LocalNet, some
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/operate/configs/supplier_staking_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,8 @@ _`Optional`_, _`Non-empty`_

```yaml
default_rev_share_percent:
<shareholder_address_1>: <float>
<shareholder_address_2>: <float>
<shareholder_address_1>: <uint32>
<shareholder_address_2>: <uint32>
```

`default_rev_share_percent` is an optional map that defines the default the revenue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/operate/quickstart/gateway_cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/operate/quickstart/service_cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/operate/quickstart/supplier_cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CLI Installation
title: poktrolld CLI Installation
sidebar_position: 0
---

Expand Down
Loading