Merge pull request #76 from 0xPolygon/km/cdk_fix

Fixing issues with CDK section

docs/_site_essentials/stylesheets/extra.css

@@ -38,4 +38,48 @@ div.flex-figure div.flex-figure-left {
 
 div.flex-figure div.flex-figure-right {
 	flex-grow: 2;
+}
+
+.feature-paragraph {
+	text-align: left;
+}
+* {
+box-sizing: border-box;
+}
+.grid-container {
+display: flex;
+flex-wrap: wrap;
+width: 100%;
+padding: 10px;
+align-items: stretch;
+}
+.grid-item {
+background-color: white;
+border-radius: 8px;
+-webkit-box-shadow: 0 8px 16px 0 rgb(17 17 17 / 8%);
+box-shadow: 0 8px 16px 0 rgb(17 17 17 / 8%);
+padding: 33px;
+margin: 5px;
+text-align: center;
+align-items: center;
+flex: 32%;
+width: 32%;  
+}
+@media screen and (max-width: 1000px) {
+.grid-item {
+flex: 32%;
+max-width: 32%;
+}
+}
+@media screen and (max-width: 800px) {
+.grid-item {
+flex: 48%;
+max-width: 48%;
+}
+}
+@media screen and (max-width: 600px) {
+.grid-item {
+flex: 100%;
+max-width: 100%;
+}
 }

docs/cdk/get-started/deploy-rollup.md

@@ -1,6 +1,10 @@
 !!! note "Recommendation"
     Follow the [quickstart](quickstart-rollup.md) for a hands-on introduction to CDK in rollup mode.
 
+!!! note
+    - The documentation describes standard deployments.
+    - Edit the configuration files to implement your own custom setups.
+
 ## Deploy a CDK rollup locally
 
 The [zkEVM deployment quickstart documentation](../../zkEVM/get-started/deploy-zkevm/index.md) shows you how to deploy a zkEVM rollup on your local machine.

docs/cdk/get-started/deploy-validium.md

@@ -1,6 +1,10 @@
 !!! important "Recommendation"
     Follow the [quickstart](quickstart-validium.md) for a hands-on introduction to CDK in validium mode.
 
+!!! note
+    - The documentation describes standard deployments. 
+    - Edit the configuration files to implement your own custom setups.
+
 Follow the steps below to deploy a CDK validium instance.
 
 ## 1. Deploy validium-specific contracts

docs/cdk/get-started/quickstart-rollup.md

@@ -1,3 +1,7 @@
+!!! note
+    - The documentation describes standard deployments.
+    - Edit the configuration files to implement your own custom setups.
+
 ## Run a CDK rollup locally
 
 The following link takes you to a quickstart guide for deploying a CDK rollup on your local machine.

docs/cdk/get-started/quickstart-validium.md

@@ -1,5 +1,9 @@
 This quickstart guides you through the process of setting up a CDK validium on your local machine.
 
+!!! note
+    - The documentation describes standard deployments. 
+    - Edit the configuration files to implement your own custom setups.
+
 ## Prerequisites
 
 ### System requirements

docs/cdk/index.md

@@ -1,10 +1,40 @@
-<div class="flex-figure" markdown="1">
-<div class="flex-figure-left" markdown="1">
-# Polygon CDK
-Polygon Chain Development Kit (CDK) is a modular, open source software toolkit for blockchain developers to launch new L2 chains on Ethereum.
-</div>
-<div class="flex-figure-right">
-<img src="../img/cdk/cdk.svg" class="figure figure-right" alt="" />
-</div>
-</div>
+---
+hide:
+- toc
+---
 
+   <div class="section-wrapper product-section-head">
+         <div class="hero-image"><img src="../img/cdk/cdk.svg" loading="lazy" class="hero-image" style="width: 40%; float: right;"></div>
+      <div class="hero-left">
+         <h1 class="hero-heading">Polygon CDK</h1>
+         <p class="hero-subtext">Polygon Chain Development Kit (CDK) is a modular, open source software toolkit for blockchain developers to launch new L2 chains on Ethereum.</p>
+      </div>
+      </br>
+   </div>
+   <div class="grid-container">
+      <div class="grid-item">
+         <a href="./get-started/quickstart-rollup">
+            <div class="product-list-item-header">
+               <div class="feature-card-heading">CDK rollups</div>
+            </div>
+            <p class="feature-paragraph">Get started with the CDK zkRollup stack.</p>
+         </a>
+      </div>
+      <div class="grid-item">
+         <a href="./get-started/quickstart-validium">
+            <div class="product-list-item-header">
+               <div class="feature-card-heading">CDK validiums</div>
+            </div>
+            <p class="feature-paragraph">Get started with the CDK validium stack.</p>
+         </a>
+      </div>
+      <div class="grid-item">
+         <a href="./spec/validium-vs-rollup">
+            <div class="product-list-item-header">
+               <div class="feature-card-heading">Rollup versus validium</div>
+            </div>
+            <p class="feature-paragraph">Discover the key differences between the rollup and validium infrastructure options.</p>
+         </a>
+      </div>
+   </div>
+   </div>

docs/cdk/overview.md

@@ -19,6 +19,9 @@ Here is what developers can expect when they build with Polygon CDK.
 5. **Near-instant finality**: Chains deployed using Polygon CDK rely on cryptographic security, ensuring transaction integrity without the need of full nodes. This approach guarantees near-instant finality and robust security.
 6. **Extensive Web3 support**: Polygon CDK chains leverage a comprehensive ecosystem with premium service providers offering essential tools for application integration, development, and deployment.
 
+!!! important "Why are there zkEVM docs in the CDK section?"
+     Several of the docs point to zkEVM specific deployment documentation because the rollup flavor of CDK uses zkEVM deployment defaults.
+
 The following diagram illustrates how Polygon CDK-developed chains may opt into a web of interoperable L2 chains: 
 
 ![](../img/cdk/overview-2.png)

docs/cdk/spec/validium-vs-rollup.md

@@ -1,5 +1,3 @@
-## Introduction
-
 Polygon CDK running in validium mode inherits the core functionalities of a zkEVM rollup node and adds a [data availability layer](../concepts/dac.md).
 
 ## Key differences

mkdocs.yml

@@ -26,7 +26,7 @@ theme:
     - search.suggest
     - search.highlight
     - search.share
-    - navigation.instant
+   # - navigation.instant
     - navigation.instant.progress
     - navigation.tracking
     - navigation.expansion
@@ -49,28 +49,24 @@ nav:
       - CDK: cdk/index.md
       - Overview: cdk/overview.md
       - Get started:
-        - Get started: cdk/get-started/index.md
         - Quickstart:
           - Validium: cdk/get-started/quickstart-validium.md
           - Rollup: cdk/get-started/quickstart-rollup.md
         - Deploy:
           - Validium: cdk/get-started/deploy-validium.md
           - Rollup: cdk/get-started/deploy-rollup.md
       - How to:
-        - How to: cdk/how-to/index.md
         - Manage policies: cdk/how-to/manage-policies.md
       #- Architecture:
       - Specification:
-        - Specification: cdk/spec/index.md
         - Validium vs rollup: cdk/spec/validium-vs-rollup.md
       - Concepts:
-        - Concepts: cdk/concepts/index.md
         - Rollup: cdk/concepts/rollup.md
         - Validium: cdk/concepts/validium.md
         - Data availability: cdk/concepts/dac.md
-     # - API:
+     # - API/SDK:
       - Additional resources:
-        - Additional resources: cdk/troubleshooting/index.md
+        - CDK repos: cdk/resources/cdk-repo-reference.md
   - zkEVM:
       - zkEVM: zkEVM/index.md
       - Overview: zkEVM/overview.md