Skip to content

Commit 2c64836

Browse files
structure language for ux
1 parent 78f43ac commit 2c64836

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/cdk/getting-started/local-deployment.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) a
2121

2222
- [Docker Engine](https://docs.docker.com/engine/) version 4.27 or higher.
2323
- [Kurtosis CLI](https://docs.kurtosis.com/install/)
24-
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
2524

2625
And for submitting transactions and interacting with the environment once set up:
2726

27+
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
2828
- [yq](https://github.com/mikefarah/yq)
2929
- [jq](https://stedolan.github.io/jq/)
3030
- [polyon-cli](https://github.com/maticnetwork/polygon-cli)
@@ -42,7 +42,8 @@ cd kurtosis-cdk
4242

4343
Run the `tool_check.sh` script to confirm you have all the prerequisite software.
4444

45-
You may need to make the script executable: `chmod +x scripts/tool_check.sh`
45+
!!! tip
46+
You may need to make the script executable: `chmod +x scripts/tool_check.sh`
4647

4748
```sh
4849
./scripts/tool_check.sh
@@ -64,14 +65,11 @@ You might as well need the following tools to interact with the environment...
6465
🎉 You are ready to go!
6566
```
6667

67-
### Customize your chain
68-
69-
To begin understanding the codebase, there are two key files to inspect:
68+
### Understanding the deployment steps
7069

71-
1. [`main.star`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/main.star): The script that defines what steps to take to set up the chain on your machine.
72-
2. [`params.yml`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/params.yml): The main configuration file that defines the parameters of the chain.
70+
There are two key files to look at which help you understand what's happening during a deployment.
7371

74-
#### `main.star`
72+
#### [`main.star`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/main.star)
7573

7674
The `main.star` file defines the step-by-step instructions of the deployment process. It is the main "hub" of the chain setup process; orchestrating the setup of all the components in sequential order by pulling in necessary logic from other files.
7775

@@ -92,7 +90,7 @@ It defines the following steps for the deployment process:
9290

9391
You can customize (or skip) the logic for each of these steps by modifying the logic in the respective files.
9492

95-
#### `params.yml`
93+
#### [`params.yml`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/params.yml)
9694

9795
The `params.yml` file defines the parameters of the chain and the deployment process. It includes configurations for simple parameters such as the chain ID and more complex configurations such as the gas token smart contract address.
9896

0 commit comments

Comments
 (0)