Skip to content

Commit 9d8c028

Browse files
OisinKyne“MaxthomasheremansHananINouman
authored
Oisin/rebase (#314)
* Just testing out the commit flow * testing 2nd change * An extra info box for CDVN, explaining that it's set to Holesky by default, and that the network can be changed with the .env.sample file. This should go live on Feb 6th, at the same time that we change CDVN to Holesky by default. * Changing the link to the DV Launchpad page of the docs with all the links, rather than a link directly to the Goerli launchpad page * changed the link to docker to directly link to the Ubuntu installation page * small changes * re-did the quickstart, merged and deleted some pages. (Generally trying to reduce complexity of folders) * adding back in the further reading folder as suggested by Toma * removing "how and where to run DVs" until it's ready, as suggested by Toma * implemented all changes suggested by Toma on our call in the morning of Feb 13th * Copy changes * Merge sdk static pages * fixed broken links * fixing more broken links * fixed all broken links (hopefully) * Fixing links (made a dummy /sdk for now) * Update guides * embed sdk markdown page in docs * update sdk.md * use docusaurus-plugin-typedoc * bump a new version to use docSidebar navbar item instead of pushing to docs/next * update versions * comment out the plugin used to geenrate sdk docs * update redoc version * use static file for api docs until fetching from docs-json error is fixed * reuse swagger json for api docs * update yarn.lock * update v0.19.1 * use static file for build to pass * use the api url * use updates sidebar with v0.19.1 * remove duplicate file * Fix SDK ref, attempt to fix links with redirects plus some rollbacks * redirect didn't work, just putting the faq folder back where it was --------- Co-authored-by: “Max <“[email protected]”> Co-authored-by: thomasheremans <[email protected]> Co-authored-by: HananINouman <[email protected]>
1 parent 1711dae commit 9d8c028

File tree

214 files changed

+9184
-3494
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

214 files changed

+9184
-3494
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ yarn-debug.log*
2121
yarn-error.log*
2222

2323
.idea/*
24+
.vscode/
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"label": "Advanced Guides",
3-
"position": 10,
3+
"position": 3,
44
"collapsed": true
55
}
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/int/quickstart/advanced/quickstart-builder-api.md renamed to docs/advanced/quickstart-builder-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Run a distributed validator cluster with the builder API (MEV-Boost
66
import Tabs from '@theme/Tabs';
77
import TabItem from '@theme/TabItem';
88

9-
# Run a cluster with MEV enabled
9+
# Enable MEV
1010

1111
:::caution
1212
Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf).

docs/int/quickstart/advanced/quickstart-combine.md renamed to docs/advanced/quickstart-combine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Run the following command:
8282

8383
```sh
8484
# Combine a clusters private keys
85-
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v0.19.0 combine --cluster-dir /opt/charon/cluster --output-dir /opt/charon/combined
85+
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v0.19.1 combine --cluster-dir /opt/charon/cluster --output-dir /opt/charon/combined
8686
```
8787

8888
This command will store the combined keys in the `output-dir`, in this case a folder named `combined`.

docs/int/quickstart/advanced/quickstart-sdk.md renamed to docs/advanced/quickstart-sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
1212
The Obol-SDK is in a beta state and should be used with caution on testnets only.
1313
:::
1414

15-
This is a walkthrough of using the [Obol-SDK](https://www.npmjs.com/package/@obolnetwork/obol-sdk) to propose a four-node distributed validator cluster for creation using the [DV Launchpad](../../../dvl/intro.md).
15+
This is a walkthrough of using the [Obol-SDK](https://www.npmjs.com/package/@obolnetwork/obol-sdk) to propose a four-node distributed validator cluster for creation using the [DV Launchpad](../dvl/intro.md).
1616

1717
## Pre-requisites
1818

@@ -85,9 +85,9 @@ console.log(
8585

8686
## Invite the Operators to complete the DKG
8787

88-
Once the Obol-API returns a `configHash` string from the `createClusterDefinition` method, you can use this identifier to invite the operators to the [Launchpad](../../../dvl/intro.md) to complete the process
88+
Once the Obol-API returns a `configHash` string from the `createClusterDefinition` method, you can use this identifier to invite the operators to the [Launchpad](../dvl/intro.md) to complete the process
8989

90-
1. Operators navigate to `https://<NETWORK_NAME_HERE>.launchpad.obol.tech/dv?configHash=<CONFIG_HASH_HERE>` and complete the [run a DV with others](../group/quickstart-group-operator.md) flow.
90+
1. Operators navigate to `https://<NETWORK_NAME_HERE>.launchpad.obol.tech/dv?configHash=<CONFIG_HASH_HERE>` and complete the [run a DV with others](../start/quickstart_group.md) flow.
9191
1. Once the DKG is complete, and operators are using the `--publish` flag, the created cluster details will be posted to the Obol API
9292
1. The creator will be able to retrieve this data with `obol.getClusterLock(configHash)`, to use for activating the newly created validator.
9393

docs/int/quickstart/advanced/quickstart-split.md renamed to docs/advanced/quickstart-split.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Charon is in a beta state and should be used with caution according to its [Term
1010

1111
This process should only be used if you want to split an *existing validator private key* into multiple private key shares for use in a Distributed Validator Cluster. If your existing validator is not properly shut down before the Distributed Validator starts, your validator may be slashed.
1212

13-
If you are starting a new validator, you should follow a [quickstart guide](../index.md) instead.
13+
If you are starting a new validator, you should follow a [quickstart guide](../start/quickstart_overview.md) instead.
1414

1515
If you use MEV-Boost, make sure you turned off your MEV-Boost service for the time of splitting the keys, otherwise you may hit [this issue](https://github.com/ObolNetwork/charon/issues/2770).
1616
:::
1717

18-
Split an existing Ethereum validator key into multiple key shares for use in an [Obol Distributed Validator Cluster](../../key-concepts#distributed-validator-cluster).
18+
Split an existing Ethereum validator key into multiple key shares for use in an [Obol Distributed Validator Cluster](../int/key-concepts.md#distributed-validator-cluster).
1919

2020

2121
## Pre-requisites
@@ -58,7 +58,7 @@ At the end of this process, you should have a tree like this:
5858
Run the following docker command to split the keys:
5959

6060
```shell
61-
CHARON_VERSION= # E.g. v0.19.0
61+
CHARON_VERSION= # E.g. v0.19.1
6262
CLUSTER_NAME= # The name of the cluster you want to create.
6363
WITHDRAWAL_ADDRESS= # The address you want to use for withdrawals.
6464
FEE_RECIPIENT_ADDRESS= # The address you want to use for fee payments.

docs/int/quickstart/advanced/self-relay.md renamed to docs/advanced/self-relay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Configure **ALL** charon nodes in your cluster to use this relay:
3535

3636
Note that a local `relay/.charon/charon-enr-private-key` file will be created next to `relay/docker-compose.yml` to ensure a persisted relay ENR across restarts.
3737

38-
A list of publicly available relays that can be used is maintained [here](../../faq/risks.md#risk-obol-hosting-the-relay-infrastructure).
38+
A list of publicly available relays that can be used is maintained [here](../int/faq/risks.md).

0 commit comments

Comments
 (0)