Merge pull request #67 from 0xPolygon/docs/update-comments

A few updates
0xPolygon · Apr 17, 2024 · ded02d9 · ded02d9
2 parents f8ddb7b + 869cd14
commit ded02d9
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,19 +1,28 @@
 ---
+comments: true
 hide:
 - toc
 ---
 
 # Overview
 
-The architectural diagram below shows how CDK stack components may interact with each other and a layer 1 blockchain.
+Kurtosis is a developer platform that allows you to package and launch a backend stack without becoming overburdened with configuration details.
+
+The Polygon developer team have implemented a Kurtosis build for the CDK stack which includes all zkEVM node components, all services, and a validium option also.
+s
+## CDK architecture
+
+The diagram below shows how CDK stack components may interact with each other and with a layer 1 blockchain.
 
 </br>
 
 ![Architecture](img/architecture.png)
 
 <br/>
 
-The [quick start documents](quickstart/deploy-stack.md) show you how to deploy a private, portable, and modular Polygon CDK developer stack with [Kurtosis](https://github.com/kurtosis-tech/kurtosis).
+## Get started
+
+The [quick start documents](quickstart/deploy-stack.md) show you how to deploy a private, portable, and modular Polygon CDK developer stack on [Kurtosis](https://github.com/kurtosis-tech/kurtosis).
 
 The deployment document is aimed at users and developers who do not necessarily want to run the latest CDK versions, or follow the full tutorials, and are happy to play around with an experimental set up.
 

diff --git a/docs/quickstart/breakdown-deployment.md b/docs/quickstart/breakdown-deployment.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Rather than executing the deployment process as a monolithic operation, you can break it down into stages and run each stage separately.
 
 ### Enable or disable stages

diff --git a/docs/quickstart/deploy-stack.md b/docs/quickstart/deploy-stack.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## Hardware requirements
 
 - A Linux-based OS (e.g., Ubuntu Server 22.04 LTS).

diff --git a/docs/quickstart/observability.md b/docs/quickstart/observability.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 The `kurtosis-cdk` stack deploys Prometheus, Grafana, and Panoptichain to help observe the network. These are enabled by default, but can be turned off by setting the `deploy_observability` to false in the `params.yml`.
 
 Find the dashboard details by running: `kurtosis enclave inspect cdk-v1`

diff --git a/docs/quickstart/set-up-node.md b/docs/quickstart/set-up-node.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 In addition to the core stack, you can also attach and synchronize a permissionless node. 
 
 ## Prerequisites

diff --git a/docs/quickstart/zkevm-cache-contracts.md b/docs/quickstart/zkevm-cache-contracts.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 We manually build zkEVM contracts images to make the deployment of the Kurtosis package as fast as possible.
 
 Indeed, most of the deployment time is spent downloading npm dependencies and compiling the zkEVM contracts.