Skip to content

Commit f41704b

Browse files
update links language in overview
1 parent ba71ea5 commit f41704b

File tree

2 files changed

+39
-29
lines changed

2 files changed

+39
-29
lines changed

docs/cdk/getting-started/index.md renamed to docs/cdk/getting-started/local-deployment.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
# Get started
1+
## Deploy CDK locally
22

3-
This _getting started_ guide walks you through the process of setting up a Layer 2 blockchain using the Polygon CDK on your local machine, running the components in Docker containers.
3+
This guide walks you through the process of setting up and deploying a layer 2 blockchain on your local machine using the Polygon CDK with [Kurtosis](https://docs.kurtosis.com/).
44

5-
## Setting up your environment
5+
The components run in Docker containers.
66

7-
To run the Polygon CDK locally, the following prerequisites are required:
7+
## Prerequisites
88

9-
Hardware Requirements:
9+
### Hardware
1010

11-
- A Linux-based Operating System (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about))
12-
- Minimum 8GB RAM and 2-core CPU
13-
- An AMD64 architecture system
11+
- A Linux-based operating system (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)).
12+
- Minimum 8GB RAM and 2-core CPU.
13+
- An AMD64 architecture system.
1414

15-
Software Dependencies:
15+
### Software
1616

17-
- [Docker Engine](https://docs.docker.com/engine/) (version 4.27 or higher)
17+
- [Docker Engine](https://docs.docker.com/engine/) version 4.27 or higher.
1818
- [Kurtosis CLI](https://docs.kurtosis.com/install/)
1919
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
20-
- Optional: [yq](https://github.com/mikefarah/yq), [jq](https://stedolan.github.io/jq/), and [polycli](https://github.com/maticnetwork/polygon-cli) help submit transactions and interact with the environment.
20+
- [yq](https://github.com/mikefarah/yq)
21+
- [jq](https://stedolan.github.io/jq/)
22+
- [polycli](https://github.com/maticnetwork/polygon-cli) to help submit transactions and interact with the environment.
2123

22-
## Exploring the CDK kurtosis package
24+
## Set up the Kurtosis environment
2325

24-
The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all of the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) (a Python dialect) scripts to define the step-by-step process of setting up the chain.
26+
The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) scripts (a Python dialect) that define the step-by-step process of setting up the chain.
2527

26-
### Cloning the repository
28+
### Clone the repository
2729

2830
To get started, clone the repository and navigate to the `kurtosis-cdk` directory:
2931

@@ -32,7 +34,7 @@ git clone https://github.com/0xPolygon/kurtosis-cdk.git
3234
cd kurtosis-cdk
3335
```
3436

35-
### Checking your environment
37+
### Check your environment
3638

3739
Ensure Docker is running on your machine, then run the following command to confirm that all prerequisites are installed:
3840

@@ -56,7 +58,7 @@ You might as well need the following tools to interact with the environment...
5658
🎉 You are ready to go!
5759
```
5860

59-
### Customizing your chain
61+
### Customize your chain
6062

6163
To begin understanding the codebase, there are two key files to inspect:
6264

@@ -90,7 +92,7 @@ The `params.yml` file defines the parameters of the chain and the deployment pro
9092

9193
You can modify each of these parameters to customize the chain to your specific needs.
9294

93-
## Running the chain locally
95+
## Run the chain locally
9496

9597
First run the [kurtosis clean](https://docs.kurtosis.com/clean) to remove any existing Kurtosis environments:
9698

docs/cdk/overview.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,34 @@
22
comments: true
33
---
44

5-
Polygon Chain Development Kit (CDK) is a modular, open source software toolkit for blockchain developers which supports the installation and configuration of a variety of chain architectures. Polygon CDK empowers developers to launch new L2 chains running Polygon zkEVM technology on Ethereum or, in the future, transition existing Layer 1 (L1) chains into ZK-EVM L2s.
5+
Polygon Chain Development Kit (CDK) is a modular, open source, software toolkit for blockchain developers which supports the installation and configuration of a variety of chain architectures.
6+
7+
Polygon CDK empowers developers to launch new L2 chains running Polygon zkEVM technology on Ethereum or, in the future, transition existing layer 1 (L1) chains into custom ZK-EVM L2s.
68

79
## CDK features
810

9-
Polygon CDK provides the components necessary to build a layer 2 blockchain that is secure, scalable, and interoperable with other chains. Below are some of the key features of the CDK:
11+
Polygon CDK builds layer 2 blockchains that are secure, scalable, and interoperable with other chains. Below are some of the key features of CDK:
12+
13+
- Security: CDK builds high-performance, high-security, scalable L2s that utilize the latest innovations in zero-knowledge technology such as [Plonky3](../innovation-design/plonky.md#plonky-3).
14+
15+
- Scalability: Transaction fees are orders of magnitude lower than Ethereum and processed substantially faster. This enables a fast, cheap, and secure user experience unaffected by any high activity experienced on shared networks.
16+
17+
- Modularity: CDK modular components allow developers to easily customize their L2 environment and build a chain that meets their specific needs.
18+
19+
- Interoperability: Opt-in to the [AggLayer](../cdk/agglayer/overview.md) to bootstrap your chain's ecosystem, enable cross-chain transactions, and gain access to the users and liquidity of other chains.
1020

11-
- Security: Build high-performance, high-security, scalable L2s that utilize the latest innovations in zero-knowledge technology such as [plonky3](https://docs.polygon.technology/learn/plonky/?h=plonky3#plonky-3).
21+
- Sovereignty: Maintain full control over your chain's revenue, governance, security, economic policies, and more.
1222

13-
- Scalability: Transaction fees are orders of magnitude lower and processed substantially faster compared to Ethereum. Enabling a fast, cheap, and secure user experience unaffected by any extraneous high activity experienced on shared networks.
23+
## Dive deeper into CDK
1424

15-
- Modularity: As logic is separated into modular components, developers can easily customize all components of the L2 to build a chain that meets their specific needs.
25+
Polygon CDK gives developers a toolkit for sovereign and modular chain design, without sacrificing future interoperability with other L2 chains.
1626

17-
- Interoperability: Opt-in to the [AggLayer](https://docs.polygon.technology/cdk/glossary/#agglayer-v1-al1) to bootstrap your chain’s ecosystem, enable cross-chain transactions, and access to the users and liquidity of other chains.
27+
Chains built with Polygon CDK will have access to an ecosystem of (forthcoming) unified liquidity, optimized performance, and seamless asset transfers, all while prioritizing user experience and data security.
1828

19-
- Sovereignty: Maintain full control over your chain’s revenue, governance, security, economic policies, and more.
29+
### Where to now?
2030

21-
## Dive deeper into the CDK
31+
- [Deploy a local CDK on Kurtosis](./getting-started/local-deployment.md). Follow the guide to deploy a CDK stack on your local machine.
2232

23-
Polygon CDK gives developers a toolkit for sovereign and modular chain design, without sacrificing future interoperability with other L2 chains. Chains built with Polygon CDK can access an ecosystem of (forthcoming) unified liquidity, optimized performance, and seamless asset transfers, all while prioritizing user experience and data security.
33+
- Check out the [concepts documentation](./concepts/layer2s.md) to understand the CDK at a high level.
2434

25-
- [Concepts](https://docs.polygon.technology/cdk/concepts/layer2s) to understand the CDK at a high level.
26-
- [Getting Started](https://docs.polygon.technology/cdk/getting-started) to deploy a CDK stack on your local machine.
27-
- [Architecture](https://docs.polygon.technology/cdk/architecture/cdk-zkevm/) to understand the CDK’s components and how they interact with each other.
35+
- Have a look at the [CDK architecture docs](https://docs.polygon.technology/cdk/architecture/cdk-zkevm/) to understand the CDK's components and how they interact with each other.

0 commit comments

Comments
 (0)