[Docs] E2E Preparation for Beta TestNet release (#932)

Miscellaneous improvements of the docs for the beta TestNet release. --- Co-authored-by: Dima K. <[email protected]> Co-authored-by: Redouane Lakrache <[email protected]>
pokt-network · Nov 20, 2024 · 342a076 · 342a076
1 parent 7b94020
commit 342a076
Show file tree

Hide file tree

Showing 18 changed files with 197 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ for the Shannon upgrade of the [Pocket Network](https://pokt.network) blockchain
 - [Roadmap](#roadmap)
 - [Quickstart](#quickstart)
 - [Godoc](#godoc)
-- [Have questions? Ask An PNYC](#have-questions-ask-an-pnyc)
+- [Have questions? Ask An PNYX](#have-questions-ask-an-pnyx)
 - [License](#license)
 
 ## Learn about Pocket Network
@@ -61,9 +61,9 @@ The best way to get involved is by following the [quickstart instructions](https
 
 The Godoc for the source code in this can be found at [pkg.go.dev/github.com/pokt-network/poktroll](https://pkg.go.dev/github.com/pokt-network/poktroll).
 
-## Have questions? Ask An PNYC
+## Have questions? Ask An PNYX
 
-You can use [PNYX](https://pnyxai.com/), an AI-powered search engine that has been
+You can use [PNYX](https://migration.pnyxai.com/), an AI-powered search engine that has been
 trained and indexed on the Pocket Network documentation, community calls, forums
 and much more!
 

diff --git a/app/app.go b/app/app.go
@@ -41,7 +41,8 @@ import (
 
 const (
 	AccountAddressPrefix = "pokt"
-	Name                 = "poktroll"
+	// TODO_MAINNET: Rename `poktroll` to `pocket` EVERYWHERE.
+	Name = "poktroll"
 )
 
 var (

diff --git a/docusaurus/docs/explore/genesis.md b/docusaurus/docs/explore/genesis.md
@@ -0,0 +1,8 @@
+---
+title: Genesis
+sidebar_position: 4
+---
+
+## Genesis
+
+The genesis file for the Pocket Network is located at [pokt-network-genesis](https://github.com/pokt-network/pocket-network-genesis).
diff --git a/docusaurus/docs/explore/roadmap.md b/docusaurus/docs/explore/roadmap.md
@@ -3,42 +3,62 @@ title: Roadmap
 sidebar_position: 2
 ---
 
-## Roadmap
+## Blogs & Updates
+
+- TODO_BETA(@olshansk): Pocket Network Shannon Update - Beta TestNet #1 Announcement
+- [Pocket Network Shannon Update - Alpha TestNet #3 Announcement](https://medium.com/decentralized-infrastructure/pocket-network-shannon-update-alpha-testnet-3-eca539a9e111)
+
+## Alpha TestNet Roadmap
 
 See the Alpha TestNet #3 Announcement [here](https://medium.com/decentralized-infrastructure/pocket-network-shannon-update-alpha-testnet-3-eca539a9e111).
 
 ```mermaid
 timeline
     title Shannon Roadmap
     section Morse
-      Alpha TestNets <br> (Q3):
-          Alpha TestNet 1 <br> ------- <br> Shannon Foundation:
-          Alpha TestNet 2 <br> ------- <br> Shannon SDK & Relay Mining:
-          Alpha TestNet 3 <br> ------- <br> Utility & Governance:
-          Continue Development...:
-          Tokenomics & Token Logic Modules:
-          Morse Utility Parity
-        Beta TestNets (Q3/Q4):
-          Beta TestNet 1 <br> ------- <br> Kickoff Incentivized TestNet:
-          Beta TestNet 2 <br> ------- <br> Shannon Migration:
-                Start wPOKT migration:
-                Kickoff audits
+      Alpha TestNet(s) <br> (Q3/Q4):
+	      ✅ Shannon Foundation:
+	      ✅ Shannon SDK:
+	      ✅ Relay Mining:
+	      ✅ Morse Utility Parity:
+	      ✅ Token Logic Modules:
+	      ⚙️ Governance:
+	      ⚙️ PATH Integration:
+	      ⚙️ Observability:
+	      ⚙️ Scalability Testing
+	    Beta TestNet (Q4/Q1):
+	      ⚙️  E2E Permissionless Load Testing:
+	      ⚙️  POKTScan Explorer:
+	      ⚙️  TODOs & Optimizations:
+	      ⚙️  Streamline Upgrades:
+	      IBC Integrations:
+	      EVM Interoperability:
+	      Migration module R&D:
+				Start wPOKT migration:
+				Auditing & Hardening
     section Morse & Shannon
-            Shadow Migration <br> (Q1):
-                Trusted Validators Only:
+			Shadow Migration <br> (Q1):
+				Shadow MainNet Launch:
+                Turn OFF Shannon inflation:
+				Bugs, Hardening & TECHDEBT:
+				Governance Parameter Eval:
+				Mirror Morse MainNet Traffic:
+				Tooling & Documentation Improvements:
+				Genesis File Preparation
+			Public Migration <br> (Q1):
+                Public MainNet Launch:
+				Morse POKT "Airdrop":
+				Gateway Migration:
                 Supplier Migration:
-                Send Shadow Traffic from Morse MainNet:
-                Bugs & Hardening:
-                Missing Features
-            Public Migration <br> (Q1):
-                Gateway Migration:
-                Morse Claims Enabled:
-                Exchange Operations:
-                Bridge Migration
+				Bridge Migration:
+				Onboard Morse Validators:
+				CEX Support:
+                DEX Support
     section Shannon
-        Launch & Deprecate <br> (Q2):
-            Onboard Morse validators:
-            Deprecate Morse <br>:
-            New Incentives Enabled:
-            Kickoff Post-MainNet Features
+	    Launch & Deprecate <br> (Q2):
+            Turn ON Shannon inflation:
+		    Enable New Incntives:
+		    Deprecate Morse:
+            MainNet IBC and EVM Interoperability:
+		    Kickoff Post-MainNet R&D
 ```
diff --git a/docusaurus/docs/explore/rpc.md b/docusaurus/docs/explore/rpc.md
@@ -3,17 +3,30 @@ title: RPC Endpoints
 sidebar_position: 3
 ---
 
-## TestNet RPC Endpoints
+- [Types of RPC Endpoints](#types-of-rpc-endpoints)
+- [Beta TestNet](#beta-testnet)
+  - [Beta RPC Endpoints](#beta-rpc-endpoints)
+  - [Beta JSON-RPC Example](#beta-json-rpc-example)
+- [Alpha TestNet](#alpha-testnet)
+  - [Alpha RPC Endpoints](#alpha-rpc-endpoints)
+  - [Alpha JSON-RPC Example](#alpha-json-rpc-example)
 
-We have provided `gRPC`, `JSON-RPC` and `REST` endpoints, which are available here:
+## Types of RPC Endpoints
 
-- `https://shannon-testnet-grove-seed-rpc.poktroll.com`
-- `https://shannon-testnet-grove-seed-grpc.poktroll.com`
-- `https://shannon-testnet-grove-seed-api.poktroll.com`
 
 You can review the difference between them in the [Cosmos SDK docs](https://docs.cosmos.network/main/learn/advanced/grpc_rest#comparison-table).
 
-### JSON-RPC
+## Beta TestNet
+
+### Beta RPC Endpoints
+
+We provide `gRPC`, `JSON-RPC` and `REST` endpoints, which are available here:
+
+- **RPC**: `https://shannon-testnet-grove-seed-rpc.beta.poktroll.com`
+- **gRPC**: `https://shannon-testnet-grove-seed-grpc.beta.poktroll.com`
+- **REST**: `https://shannon-testnet-grove-seed-api.beta.poktroll.com`
+
+### Beta JSON-RPC Example
 
 Using `curl`:
 
@@ -27,10 +40,26 @@ Using the `poktrolld` binary:
 poktrolld query block --type=height 0 --node https://shannon-testnet-grove-seed-rpc.poktroll.com
 ```
 
-### gRPC
+## Alpha TestNet
 
-_TODO_TECHDEBT: Add a gRPC example_
+### Alpha RPC Endpoints
 
-### REST
+We provide `gRPC`, `JSON-RPC` and `REST` endpoints, which are available here:
+
+- **RPC**: `https://shannon-testnet-grove-seed-rpc.alpha.poktroll.com`
+- **gRPC**: `https://shannon-testnet-grove-seed-grpc.alpha.poktroll.com`
+- **REST**: `https://shannon-testnet-grove-seed-api.alpha.poktroll.com`
+
+### Alpha JSON-RPC Example
+
+Using `curl`:
 
-_TODO_TECHDEBT: Add a REST example_
+```bash
+curl -X POST https://shannon-testnet-grove-seed-rpc.alpha.poktroll.com/block
+```
+
+Using the `poktrolld` binary:
+
+```bash
+poktrolld query block --type=height 1 --node https://shannon-testnet-grove-seed-rpc.alpha.poktroll.com
+```
diff --git a/docusaurus/docs/explore/tools.md b/docusaurus/docs/explore/tools.md
@@ -3,10 +3,24 @@ title: Tools & References
 sidebar_position: 1
 ---
 
-## 🛠️ Tools & References <!-- omit in toc -->
+- [Beta TestNet](#beta-testnet)
+- [Alpha TestNet](#alpha-testnet)
+- [🛠️ Tools \& References](#️-tools--references)
+
+## Beta TestNet
+
+- 🪙 [Shannon Beta Token Faucet](https://faucet.beta.testnet.pokt.network/)
+- 🗺️ [Shannon Beta Explorer](https://shannon.beta.testnet.pokt.network)
+- 🗺️ [PoktScan's Shannon Beta Explorer](https://shannon.beta.poktscan.com/)
+
+## Alpha TestNet
+
+- 🪙 [Shannon Alpha Token Faucet](https://faucet.alpha.testnet.pokt.network/)
+- 🗺️ [Shannon Alpha Explorer](https://shannon.alpha.testnet.pokt.network)
+- 🗺️ [PoktScan's Shannon Alpha Explorer](https://shannon.alpha.poktscan.com/)
+
+## 🛠️ Tools & References
 
-- 🪙 [Shannon Token Faucet](https://faucet.testnet.pokt.network/)
-- 🗺️ [Shannon Explorer](https://shannon.testnet.pokt.network/poktroll/block)
 - 🏗️ [Deploy your own gateway & Supplier](https://dev.poktroll.com/operate/quickstart/docker_compose_walkthrough)
 - 🍝 [Copy-pasta your way to deploying on a Debian server](https://dev.poktroll.com/operate/quickstart/docker_compose_debian_cheatsheet)
 - 🧑‍💻 [Developer Onboarding](https://dev.poktroll.com/develop/developer_guide/quickstart)

diff --git a/docusaurus/docs/operate/infrastructure/_category_.json b/docusaurus/docs/operate/infrastructure/_category_.json
@@ -1,5 +1,5 @@
 {
-  "label": "Infrastructure",
+  "label": "Networks",
   "position": 5,
   "link": {
     "type": "generated-index",

diff --git a/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md b/docusaurus/docs/operate/quickstart/gateway_cheatsheet.md
@@ -0,0 +1,14 @@
+---
+sidebar_position: 5
+title: Gateway Cheat Sheet
+---
+
+## Gateway Cheat Sheet <!-- omit in toc -->
+
+:::tip
+
+See the [Gateway Walkthrough](./../run_a_node/gateway_walkthrough.md) for an in-depth guide on setting up a Gateway, troubleshooting, observability and more.
+
+:::
+
+TODO_BETA(@red-0ne): Finish this page.
diff --git a/docusaurus/docs/operate/quickstart/service_cheatsheet.md b/docusaurus/docs/operate/quickstart/service_cheatsheet.md
@@ -0,0 +1,8 @@
+---
+sidebar_position: 6
+title: Service Cheat Sheet
+---
+
+## Service Cheat Sheet <!-- omit in toc -->
+
+TODO_BETA(@olshansk): Document how to add a service onchain.
diff --git a/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md b/docusaurus/docs/operate/quickstart/supplier_cheatsheet.md
@@ -0,0 +1,14 @@
+---
+sidebar_position: 4
+title: Supplier Cheat Sheet
+---
+
+## Supplier Cheat Sheet <!-- omit in toc -->
+
+:::tip
+
+See the [Supplier Walkthrough](./../run_a_node/supplier_walkthrough.md) for an in-depth guide on setting up a Supplier.
+
+:::
+
+TODO_BETA(@olshansk): Finish this page.
diff --git a/docusaurus/docs/operate/quickstart/validator_cheatsheet.md b/docusaurus/docs/operate/quickstart/validator_cheatsheet.md
@@ -0,0 +1,14 @@
+---
+sidebar_position: 3
+title: Validator Cheat Sheet
+---
+
+## Validator Cheat Sheet <!-- omit in toc -->
+
+:::tip
+
+See the [Validator Walkthrough](./../run_a_node/validator_walkthrough.md) for an in-depth guide on setting up a Validator Node.
+
+:::
+
+TODO_BETA(@okdas): Finish this page.
diff --git a/docusaurus/docs/operate/run_a_node/_category_.json b/docusaurus/docs/operate/run_a_node/_category_.json
@@ -1,5 +1,5 @@
 {
-  "label": "Run a Node",
+  "label": "Run a Node Walkthroughs",
   "position": 3,
   "link": {
     "type": "generated-index",

diff --git a/docusaurus/docs/operate/run_a_node/full_node_cosmovisor.md b/docusaurus/docs/operate/run_a_node/full_node_cosmovisor.md
@@ -1,5 +1,5 @@
 ---
-title: Full Node - Cosmovisor
+title: Full Node (Cosmovisor)
 sidebar_position: 2
 ---
 

diff --git a/docusaurus/docs/operate/run_a_node/full_node_docker.md b/docusaurus/docs/operate/run_a_node/full_node_docker.md
@@ -1,5 +1,5 @@
 ---
-title: Full Node - Docker
+title: Full Node (Docker)
 sidebar_position: 3
 ---
 
@@ -44,8 +44,8 @@ There are two types of Full Nodes:
 ## Pocket Network Full Nodes
 
 Within Pocket Network, the role of Full Nodes is pivotal for Node Runners. These
-nodes needed for off-chain entities like [RelayMiners](./relay_miner.md) and
-[AppGates](./appgate_server.md), which rely on interaction with the Pocket Network
+nodes needed for off-chain entities like [RelayMiners (Suppliers)](./supplier_walkthrough.md) and
+[Gateways](./gateway_walkthrough.md), which rely on interaction with the Pocket Network
 blockchain for full functionality.
 
 This guide outlines how to configure, deploy and maintain Full Nodes.

diff --git a/...docs/operate/run_a_node/appgate_server.md → ...operate/run_a_node/gateway_walkthrough.md b/...docs/operate/run_a_node/appgate_server.md → ...operate/run_a_node/gateway_walkthrough.md
@@ -1,9 +1,11 @@
 ---
-title: AppGate Server
+title: Gateway Walkthrough
 sidebar_position: 4
 ---
 
-# Run an AppGate Server <!-- omit in toc -->
+# Run a Gateway <!-- omit in toc -->
+
+TODO_BETA(@red-0ne): Update this page to use PATH.
 
 - [What is AppGate Server?](#what-is-appgate-server)
 - [AppGate Server Operation Requirements](#appgate-server-operation-requirements)

diff --git a/...us/docs/operate/run_a_node/relay_miner.md → ...perate/run_a_node/supplier_walkthrough.md b/...us/docs/operate/run_a_node/relay_miner.md → ...perate/run_a_node/supplier_walkthrough.md
@@ -1,9 +1,11 @@
 ---
-title: RelayMiner
+title: RelayMiner (Supplier) Walkthrough
 sidebar_position: 5
 ---
 
-# Run a RelayMiner <!-- omit in toc -->
+# Run a RelayMiner (Supplier) <!-- omit in toc -->
+
+TODO_BETA(@olshansk): Update this page with all the details.
 
 - [What is a RelayMiner](#what-is-a-relayminer)
 - [RelayMiner Operation Requirements](#relayminer-operation-requirements)

diff --git a/docusaurus/docs/operate/run_a_node/validator_walkthrough.md b/docusaurus/docs/operate/run_a_node/validator_walkthrough.md
@@ -0,0 +1,8 @@
+---
+title: Validator Walkthrough
+sidebar_position: 6
+---
+
+# Run a Validator <!-- omit in toc -->
+
+TODO_BETA(@okdas): Update this page with all the details.
diff --git a/docusaurus/yarn.lock b/docusaurus/yarn.lock
@@ -1810,15 +1810,10 @@
   dependencies:
     "@types/mdx" "^2.0.0"
 
-"@node-rs/jieba-linux-x64-gnu@1.10.0":
+"@node-rs/jieba-darwin-arm64@1.10.0":
   version "1.10.0"
-  resolved "https://registry.npmjs.org/@node-rs/jieba-linux-x64-gnu/-/jieba-linux-x64-gnu-1.10.0.tgz"
-  integrity sha512-rS5Shs8JITxJjFIjoIZ5a9O+GO21TJgKu03g2qwFE3QaN5ZOvXtz+/AqqyfT4GmmMhCujD83AGqfOGXDmItF9w==
-
-"@node-rs/[email protected]":
-  version "1.10.0"
-  resolved "https://registry.npmjs.org/@node-rs/jieba-linux-x64-musl/-/jieba-linux-x64-musl-1.10.0.tgz"
-  integrity sha512-BvSiF2rR8Birh2oEVHcYwq0WGC1cegkEdddWsPrrSmpKmukJE2zyjcxaOOggq2apb8fIRsjyeeUh6X3R5AgjvA==
+  resolved "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.10.0.tgz"
+  integrity sha512-IhR5r+XxFcfhVsF93zQ3uCJy8ndotRntXzoW/JCyKqOahUo/ITQRT6vTKHKMyD9xNmjl222OZonBSo2+mlI2fQ==
 
 "@node-rs/jieba@^1.6.0":
   version "1.10.0"
@@ -4619,6 +4614,11 @@ fs.realpath@^1.0.0:
   resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
+fsevents@~2.3.2:
+  version "2.3.3"
+  resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz"
+  integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
+
 function-bind@^1.1.2:
   version "1.1.2"
   resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz"