Skip to content

Commit

Permalink
docs/node: Improve links to Network Parameters page
Browse files Browse the repository at this point in the history
  • Loading branch information
gw0 committed Nov 23, 2023
1 parent 3cd9402 commit 88ce85c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
22 changes: 10 additions & 12 deletions docs/node/genesis-doc.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# Genesis Document

A genesis document contains a set of parameters that outline the initial state
of an Oasis network.

The state defined in the network's genesis document contains all the necessary
information for launching that particular network (i.e. Mainnet,
[Testnet](testnet/README.md)), including initial token allocations, network
parameters, and more.
A genesis document contains the initial state of an Oasis Network, and all the
necessary information for launching that particular network (i.g. [Mainnet],
[Testnet]).

:::info

Expand All @@ -31,8 +27,11 @@ When Oasis Node loads a genesis file, it converts it to a genesis document.
:::info

Up to date information about the current genesis file and the current genesis
document's hash can be found on the [Network Parameters](mainnet/README.md)
page.
document's hash can be found on the Network Parameters page ([Mainnet],
[Testnet]).

[Mainnet]: mainnet/README.md
[Testnet]: testnet/README.md

:::

Expand All @@ -42,9 +41,8 @@ This sections explains some of the key parameters of the genesis document.

:::caution

The concrete parameter values in the following sections pertain to the Mainnet.
Other Oasis networks (e.g. [Testnet](testnet/README.md)) might use different
values.
The concrete parameter values in the following sections pertain to the [Mainnet].
Other Oasis networks (e.g. [Testnet]) might use different values.

:::

Expand Down
12 changes: 6 additions & 6 deletions docs/node/run-your-node/maintenance/handling-network-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The specific Oasis Core version requirements also impact the way how you
and then sequentially perform seamless upgrade(s).

For example, at time of writing this guide in order to sync your node from
scratch on the [Testnet network][Testnet Parameters] you needed to do the
scratch on the [Testnet Network Parameters][Testnet] you needed to do the
following:

- Download the genesis document and run Oasis Core 22.0.x which synced
Expand All @@ -33,7 +33,7 @@ following:

The expected versions of the Oasis Core to sync your node from the latest
genesis document on the Mainnet and Testnet are always published on the
[Network Parameters] and [Testnet Parameters] pages respectively.
Network Parameters page ([Mainnet], [Testnet]).

## Reaching Upgrade Epoch

Expand Down Expand Up @@ -78,8 +78,8 @@ Once the upgrade epoch is reached, follow the instructions in the corresponding
[upgrade log].

[upgrade log]: ../../mainnet/upgrade-log.md
[Network Parameters]: ../../mainnet/README.md
[Testnet Parameters]: ../../testnet/README.md
[Mainnet]: ../../mainnet/README.md
[Testnet]: ../../testnet/README.md
[Testnet upgrade 2022-04-04]: ../../testnet/upgrade-log.md#2022-04-04-upgrade
[Testnet upgrade 2022-03-03]: ../../testnet/upgrade-log.md#2022-03-03-upgrade
[Testnet upgrade 2021-08-11]: ../../testnet/upgrade-log.md#2021-08-11-upgrade
Expand Down Expand Up @@ -114,8 +114,8 @@ State Changes], [Cobalt upgrade's Proposed State Changes]).

### Download and Verify the Provided Genesis File {#verify-genesis}

In addition, download the new genesis file linked in the [Network Parameters]
and save it as `/node/etc/genesis.json`.
In addition, download the new genesis file linked in the Network Parameters
page ([Mainnet], [Testnet]) and save it as `/node/etc/genesis.json`.

Compare the dumped state with the downloaded genesis file:

Expand Down
2 changes: 1 addition & 1 deletion docs/node/web3.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ First, follow the
[Oasis ParaTime client node](run-your-node/paratime-client-node.mdx)
guide on how to configure the Oasis client node with one or more ParaTimes.
Always use the exact combination of the Oasis node/ParaTime versions as
published on the network parameters page for either [Mainnet] or [Testnet].
published on the Network Parameters page ([Mainnet], [Testnet]).

Apart from the transactions that happen on-chain and produce some effects,
there are also a number of read-only queries implemented in the Oasis protocol
Expand Down

0 comments on commit 88ce85c

Please sign in to comment.