further cleanup

hdevalence · hdevalence · commit af9b159a73db · 2024-07-23T10:14:38.000-04:00
diff --git a/pages/cometbft_version.md b/pages/cometbft_version.md
diff --git a/pages/dev.md b/pages/dev.md
@@ -1,3 +1 @@
-# Development
-
 This section is for developers working on Penumbra source code.
diff --git a/pages/dev/build.md b/pages/dev/build.md
@@ -1,5 +1,3 @@
-# Compiling from source
-
 Penumbra is written in Rust. To build it, you will need a recent
 stable version of Rust, as well as a few OS-level dependencies.
 We don't support building on Windows. If you need to use Windows,
diff --git a/pages/dev/devnet-quickstart.md b/pages/dev/devnet-quickstart.md
@@ -1,5 +1,3 @@
-# Devnet Quickstart
-
 This page describes a quickstart method for running `pd`+`cometbft` to test
 changes during development.
 
diff --git a/pages/dev/docs.md b/pages/dev/docs.md
@@ -1,5 +1,3 @@
-# Building documentation
-
 ## mdBook docs
 The [protocol docs] and the [guide] (this document) are built using
 [mdBook] and auto-deployed on pushes to `main`. To build locally:
diff --git a/pages/dev/ibc.md b/pages/dev/ibc.md
@@ -1,5 +1,3 @@
-# Testing IBC
-
 This guide explains how to work with IBC functionality
 while developing Penumbra.
 
diff --git a/pages/dev/metrics.md b/pages/dev/metrics.md
@@ -1,5 +1,3 @@
-# Metrics
-
 Metrics are an important part of observability, allowing us to understand what
 the Penumbra software is doing. Penumbra Labs runs Grafana instances for the public deployments:
 
diff --git a/pages/dev/parameter_setup.md b/pages/dev/parameter_setup.md
@@ -1,7 +1,3 @@
-# Zero-Knowledge Proofs
-
-## Test Parameter Setup
-
 Penumbra's zero-knowledge proofs require circuit-specific parameters to be
 generated in a preprocessing phase. There are two
 keys generated for each circuit, the *Proving Key* and *Verifying Key* - used by the
diff --git a/pages/dev/protobuf.md b/pages/dev/protobuf.md
@@ -1,5 +1,3 @@
-# Maintaining protobuf specs
-
 The Penumbra project dynamically generates code for interfacing
 with [gRPC]. The following locations within the repository
 are relevant:
diff --git a/pages/dev/rpc.md b/pages/dev/rpc.md
@@ -1,5 +1,3 @@
-# Working with gRPC for Penumbra
-
 The Penumbra [`pd`](../node/pd.md) application exposes a [gRPC] service for integration
 with other tools, such as [`pcli`](../pcli.md) or the [web extension](../web.md).
 A solid understanding of how the gRPC methods work is helpful when
diff --git a/pages/dev/sql.md b/pages/dev/sql.md
@@ -1,5 +1,3 @@
-# Working with SQLite
-
 The view server uses [SQLite3](https://sqlite.org) to store client state locally.
 During debugging, you may wish to interact with the sqlite db directly.
 To do so:
diff --git a/pages/node.md b/pages/node.md
@@ -1,5 +1,3 @@
-# Running a node
-
 Running a node is not necessary to use the protocol. Both the web extension and
 `pcli` are designed to operate with any RPC endpoint. However, we've tried to
 make it as easy as possible to run nodes so that users can host their own RPC.
diff --git a/pages/node/pclientd.md b/pages/node/pclientd.md
@@ -1,5 +1,3 @@
-# Local RPC with `pclientd`
-
 Penumbra's architecture separates public shared state from private per-user
 state.  Each user's state is known only to them and other parties they disclose
 it to.  While this provides many advantages -- and enables the core features of
diff --git a/pages/node/pclientd/_meta.json b/pages/node/pclientd/_meta.json
@@ -1,5 +1,5 @@
 {
-  "configure": "Configuring `pclientd`",
+  "configure": "Configuring pclientd",
   "rpc": "Making RPC requests",
   "build_transaction": "Building Transactions"
-}
+}
diff --git a/pages/node/pclientd/build_transaction.md b/pages/node/pclientd/build_transaction.md
@@ -1,5 +1,3 @@
-# Building Transactions
-
 Using the view and custody services to construct a transaction has four steps.
 
 ## Plan the Transaction
diff --git a/pages/node/pclientd/configure.md b/pages/node/pclientd/configure.md
@@ -1,5 +1,3 @@
-# Configuring `pclientd`
-
 First, install `pclientd` following the [instructions for installing
 `pcli`](../../pcli/install.md) but downloading `pclientd` rather than `pcli`.
 
diff --git a/pages/node/pclientd/rpc.md b/pages/node/pclientd/rpc.md
@@ -1,5 +1,3 @@
-# Making RPC requests
-
 `pclientd` exposes a GRPC and GRPC-web endpoint at its `bind_addr`. Several
 services are available.
 
diff --git a/pages/node/pd.md b/pages/node/pd.md
@@ -1,11 +1,15 @@
-# Using pd
-
 This section describes how to build and run `pd`, the node implementation for
-Penumbra:
+Penumbra.  This is not necessary to use Penumbra, but promotes decentralization
+and allows deeper interactions with network data.
+
+The [Tutorial](./pd/running-node.md) section has a quickstart tutorial for setting up `pd` on a bare metal server rented from a cloud provider.
+
+The other pages describe running a node in detail:
 
 - [Requirements](./pd/requirements.md) describes the compute resource necessary to run a Penumbra node;
-- [Installing `pd`](./pd/install.md) describes how to build `pd`;
-- [Joining a network](./pd/join-network.md) describes how to join a remote network;
-- [Creating a network](../dev/devnet-quickstart.md) describes how to create a devnet, for instance for local development.
+- [Installing `pd`](./pd/install.md) describes how to install or build `pd`;
+- [Joining a network](./pd/join-network.md) describes how to join an existing Penumbra network;
+- [Becoming a validator](./pd/validator.md) describes how to become a validator and participate in consensus;
+- [Indexing ABCI events](./pd/validator.md) describes how to ingest events into a database for further processing or analysis;
 
-If you're looking for a lightweight solution to interact with the Penumbra network, see the [pclientd](../node/pclientd.md) docs.
+Finally, the [FAQs](./pd/debugging.md) page has frequently asked questions about running a node.
diff --git a/pages/node/pd/_meta.json b/pages/node/pd/_meta.json
@@ -1,9 +1,10 @@
 {
+  "running-node": "Tutorial",
   "requirements": "Requirements",
-  "install": "Installing `pd`",
+  "install": "Installing pd",
   "join-network": "Joining a network",
   "validator": "Becoming a validator",
   "chain-upgrade": "Performing a chain upgrade",
   "indexing-events": "Indexing ABCI events",
-  "debugging": "Debugging"
-}
+  "debugging": "FAQs"
+}
diff --git a/pages/node/pd/chain-upgrade.md b/pages/node/pd/chain-upgrade.md
@@ -1,5 +1,3 @@
-# Performing chain upgrades
-
 When consensus-breaking changes are made to the Penumbra protocol,
 node operators must coordinate upgrading to the new version of the software
 at the same time. Penumbra uses a governance proposal for scheduling upgrades
diff --git a/pages/node/pd/debugging.md b/pages/node/pd/debugging.md
@@ -1,5 +1,3 @@
-# Debugging a Penumbra node
-
 Below are a list of FAQs about running a Penumbra node.
 
 ## How do I check whether my node is connected to other peers?
diff --git a/pages/node/pd/indexing-events.md b/pages/node/pd/indexing-events.md
@@ -1,5 +1,3 @@
-# Indexing ABCI events
-
 The `pd` software emits ABCI events while processing blocks. By default,
 these blocks are stored in CometBFT's key-value database locally, but node operators
 can opt-in to writing the events to an external PostgreSQL database.
diff --git a/pages/node/pd/join-network.md b/pages/node/pd/join-network.md
@@ -1,5 +1,3 @@
-# Joining a network
-
 We provide instructions for running both fullnode deployments and validator deployments. A
 fullnode will sync with the network but will not have any voting power, and will
 not be eligible for staking or funding stream rewards. For more information on
diff --git a/pages/node/pd/requirements.md b/pages/node/pd/requirements.md
@@ -1,5 +1,3 @@
-# Requirements for running a node
-
 In order to run a Penumbra fullnode, you'll need a machine
 with sufficient resources. See specifics below.
 
@@ -10,6 +8,11 @@ We recommend using a machine with at least:
 * 8GB RAM
 * 2-4 vCPUS
 * ~200GB persistent storage (~20GB/week)
+* Non-virtualized SSD storage
+
+Virtualized SSDs found on many cloud providers have poor IOPS and will cause
+unpredictable performance. This may be fine for personal use, but RPC nodes
+should use non-virtualized storage.
 
 You can host your node on hardware, or on your cloud provider of choice.
 
diff --git a/pages/node/pd/running-node.md b/pages/node/pd/running-node.md
@@ -1,11 +1,9 @@
-# Running a fullnode
-
 In order to interact with the Penumbra network, users must provide an RPC URL
 so that client software can read chain state and submit transactions.
 This is true of the [Prax wallet], and of [pcli], as well as any other client.
 While users can select a publicly available RPC URL from a party they trust,
 this guide demonstrates how a user can self-host an RPC URL for use by themselves and others.
-For a more generalized description of running pd, see the [pd overview](../node/pd.md).
+For a more generalized description of running pd, see the [other sections in this chapter](../pd.md).
 
 ## Renting a server
 
diff --git a/pages/node/pd/validator.md b/pages/node/pd/validator.md
@@ -1,5 +1,3 @@
-# Becoming a validator
-
 After [starting your node](./join-network.md), you should now be participating in the
 network as a fullnode. If you wish to run a validator, you'll need to perform additional
 steps.
diff --git a/pages/pcli.md b/pages/pcli.md
@@ -1,5 +1,3 @@
-# Using pcli
-
 This section describes how to use `pcli`, the command line client for Penumbra:
 
 - [Installation](./pcli/install.md) describes how to compile and run `pcli`;
diff --git a/pages/pcli/_meta.json b/pages/pcli/_meta.json
@@ -1,8 +1,7 @@
 {
   "install": "Installing pcli",
   "wallet": "Generating a Wallet",
-  "update": "Updating to the latest testnet",
   "balance": "Viewing Balances",
   "transaction": "Sending Transactions",
   "governance": "Using Governance"
-}
+}
diff --git a/pages/pcli/balance.md b/pages/pcli/balance.md
@@ -1,5 +1,3 @@
-# Viewing Balances
-
 Once you've received your first tokens, you can scan the chain to import them
 into your local wallet (this may take a few minutes the first time you run it):
 
diff --git a/pages/pcli/governance.md b/pages/pcli/governance.md
@@ -1,5 +1,3 @@
-# Governance
-
 Penumbra features on-chain governance similar to Cosmos Hub, with the simplification that there are
 only 3 kinds of vote: yes, no, and abstain.
 
diff --git a/pages/pcli/install.md b/pages/pcli/install.md
@@ -1,5 +1,3 @@
-# Installing pcli
-
 Download prebuilt binaries from the [Penumbra releases page on Github](https://github.com/penumbra-zone/penumbra/releases).
 Make sure to use the most recent version available, as the version of `pcli` must
 match the software currently running on the network.
diff --git a/pages/pcli/transaction.md b/pages/pcli/transaction.md
@@ -1,5 +1,3 @@
-## Sending Transactions
-
 Now, for the fun part: sending transactions. If you have someone else's testnet address, you can
 send them any amount of any asset you have.
 
diff --git a/pages/pcli/update.md b/pages/pcli/update.md
diff --git a/pages/pcli/wallet.md b/pages/pcli/wallet.md
@@ -1,5 +1,3 @@
-# Generating a Wallet
-
 On first [installation of `pcli`](./install.md), you will need to generate a fresh wallet to use with Penumbra.
 
 The `pcli init` command will generate a configuration file, depending on the
diff --git a/pages/pcli/wallet/softkms.md b/pages/pcli/wallet/softkms.md
@@ -1,5 +1,3 @@
-# Software Custody Backend
-
 The `softkms` custody backend stores the spending key unencrypted in the pcli configuration file.
 
 To generate a new wallet, try:
diff --git a/pages/pcli/wallet/threshold.md b/pages/pcli/wallet/threshold.md
@@ -1,5 +1,3 @@
-# Threshold Custody Backend
-
 This backend allows splitting the spend authority (the ability to *spend* funds) among multiple parties.
 Each of these parties will have full viewing authority (the ability to decrypt and view the wallet's on-chain activity).
 
diff --git a/pages/penumbra_version.md b/pages/penumbra_version.md
diff --git a/pages/privacy.md b/pages/privacy.md
diff --git a/pages/resources.md b/pages/resources.md
@@ -1,5 +1,3 @@
-# Resources
-
 This page links to various resources that are helpful for working with and
 understanding Penumbra.
 
diff --git a/pages/tutorials.md b/pages/tutorials.md
diff --git a/pages/tutorials/_meta.json b/pages/tutorials/_meta.json
diff --git a/pages/web.md b/pages/web.md
@@ -1,5 +1,3 @@
-# Using the web extension
-
 This section describes how to use the Penumbra Wallet web extension, a GUI client for Penumbra.
 
 Currently, the web extension only supports a subset of functionality of the
diff --git a/theme.config.jsx b/theme.config.jsx
@@ -1,7 +1,11 @@
 export default {
-  logo: <span>My Nextra Documentation</span>,
+  logo: <span>Penumbra Guide</span>,
   project: {
-    link: 'https://github.com/shuding/nextra'
-  }
+    link: 'https://github.com/penumbra-zone/penumbra-guide'
+  },
+  footer: {
+    text: ''
+  },
+  docsRepositoryBase: 'https://github.com/penumbra-zone/penumbra-guide',
   // ... other theme options
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		- "configure": "Configuring `pclientd`",
	`2`	`+ "configure": "Configuring pclientd",`
`3`	`3`	`"rpc": "Making RPC requests",`
`4`	`4`	`"build_transaction": "Building Transactions"`
`5`		`-}`
	`5`	`+}`