Skip to content

Commit 5608f73

Browse files
EmpieichOhsutaiyu
andauthored
Apply suggestions from code review
Co-authored-by: hsutaiyu <51791408+hsutaiyu@users.noreply.github.com>
1 parent ab4c60f commit 5608f73

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/cdk/getting-started/cdk-cli-tool.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
The Polygon Chain Development Kit, or simply CDK, is a tool box of components that a chain administrator can use to build a rollup or validium chain.
1+
The Polygon Chain Development Kit (CDK) is a comprehensive set of components that enable chain administrators to build and deploy rollup or validium chains.
22

3-
At a high level, CDK components are like building blocks a chain administrator can select to configure a ZK-powered chain according to their own design.
3+
At a high level, CDK components are like modular building blocks that a chain administrator can use to configure a ZK-powered chain tailored to their design requirements.
44

5-
To abstract away the complexity of running or configuring CDK components, Polygon provides a Rust-based CLI tool which is an interface that chain administrators can use to interact with CDK components.
5+
To simplify the process of running and configuring CDK components, Polygon provides a Rust-based CLI tool which is an interface that chain administrators can use to interact with the components.
66

77
This CLI tool is an entry point for chain administrators to access the CDK system.
88

99
## Installation
1010

11-
To use the CLI tool the chain admin needs only download the precompiled CDK package ([the binaries](https://github.com/0xPolygon/cdk/releases/)).
11+
As the chain admin, you simply need to download the precompiled [CDK package binaries](https://github.com/0xPolygon/cdk/releases/).
1212

13-
There is no need to have Golang, checkout the CDK repo, or install anything else. It is also trustless.
13+
There is no need to install Golang, browse the CDK repo, or set up any additional tools. Moreover, the process is entirely trustless.
1414

1515
## Running the CLI tool
1616

@@ -24,7 +24,7 @@ There is no need to have Golang, checkout the CDK repo, or install anything else
2424

2525
### CDK
2626

27-
Here the Admin needs to provide the CDK-node configuration file and a genesis file of the desired chain.
27+
Here, you need to provide the CDK node configuration file and the genesis file for your desired chain.
2828

2929
Usage: `cdk <COMMAND>`
3030

@@ -37,9 +37,9 @@ Commands:
3737
Options:
3838
* `-h, --help` - Print help
3939

40-
### cdk node
40+
### `cdk node`
4141

42-
To run cdk-node use the `node` subcommand
42+
To run cdk-node use the `node` subcommand with one of the options mentioned below.
4343

4444
Usage: `cdk node [OPTIONS]`
4545

@@ -48,11 +48,11 @@ Options:
4848
* `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
4949
* `-h, --help` - Print help
5050

51-
### cdk erigon
51+
### `cdk erigon`
5252

53-
Chain administrators can run a cdk-erigon RPC node that syncs to an existing chain with default parameters.
53+
You can run a cdk-erigon RPC node that syncs to an existing chain using the default parameters.
5454

55-
This subcommand is intended for quickly spin-up of an RPC node or to test existing chains with default configuration values. In order fine tune and to access all configuration values, check the [full cdk-erigon documentation](../../cdk/getting-started/cdk-erigon/index.md) reference to erigon configuration docs.
55+
This subcommand is intended for quickly spinning up an RPC node or testing existing chains with default configuration values. In order to fine-tune settings and access all available configuration options, refer to the [full cdk-erigon documentation](../../cdk/getting-started/cdk-erigon/index.md) on Erigon configuration.
5656

5757
Usage: `cdk erigon [OPTIONS]`
5858

@@ -61,11 +61,11 @@ Options:
6161
* `-g, --chain <CHAIN>` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`]
6262
* `-h, --help` - Print help
6363

64-
### cdk versions
64+
### `cdk versions`
6565

66-
The above command generates all the required configuration files for cdk-erigon on-the-fly and run the node.
66+
The above command generates all the required configuration files for cdk-erigon on the fly and runs the node.
6767

68-
Output the corresponding versions of the components
68+
To print the corresponding versions of the components, run the following command:
6969

7070
Usage: `cdk versions`
7171

0 commit comments

Comments
 (0)