From 3b96d36e7fe85d0e788fb237ec19da0401e81c47 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Fri, 28 Mar 2025 09:35:27 -0400 Subject: [PATCH 01/11] Update mkdocs.yml --- mkdocs.yml | 54 ++++++++++++++++-------------------------------------- 1 file changed, 16 insertions(+), 38 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2bf2b9e3e..edfd47453 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Polygon Knowledge Layer site_author: Polygon Labs -copyright: Copyright © 2024 Polygon Labs +copyright: Copyright © 2025 Polygon Labs repo_name: Polygon Knowledge Layer repo_url: https://github.com/0xPolygon/polygon-docs edit_uri: edit/main/docs/ @@ -52,55 +52,34 @@ nav: - Home: index.md - Agglayer: "https://docs.agglayer.dev" - CDK: - - Polygon CDK: cdk/index.md - - Overview: cdk/overview.md - - Current Release: - - Release Notes: cdk/releases/release-notes.md + - Polygon CDK Overview: cdk/overview.md - Get Started: - Quickstart: cdk/getting-started/local-deployment.md - CLI Tool: cdk/getting-started/cli-tool.md + - Stacks: - CDK Erigon: - Overview: cdk/getting-started/cdk-erigon/index.md - - Release: cdk/getting-started/cdk-erigon/release.md + - Architecture: cdk/architecture/cdk-zkevm.md + - Release Notes: cdk/getting-started/cdk-erigon/release.md - How To: - Deploy a Node: cdk/getting-started/cdk-erigon/deploy-cdk-erigon.md - Configure Chains Dynamically: cdk/getting-started/cdk-erigon/chain-config.md - - Recover the Network: cdk/getting-started/cdk-erigon/network-recovery.md - - Resources: cdk/getting-started/cdk-erigon/resources.md + - Migration Guide: cdk/how-to/migrate/fork.md + - CDK OP-Geth: + - Overview: cdk/stacks/cdk-opgeth/index.md + - Architecture: cdk/stacks/cdk-opgeth/architecture.md - How To: - - Migration Guides: - - General Guide: cdk/how-to/migrate/fork.md - - Fork ID 9 to 12: cdk/how-to/migrate/forkid-9-12.md - - Fork ID 7 to 9: cdk/how-to/migrate/forkid-7-to-9.md - - Create A Native Token: cdk/how-to/use-native-token.md + - Create a Native Token: cdk/how-to/use-native-token.md - Integrate DA Layer: cdk/how-to/integrate-da.md - - Manage Allowlists with Policies: cdk/how-to/manage-policies.md - - Quickly Test a Running Stack: cdk/how-to/quick-test-stack.md - - Connect to CDK Testnets: cdk/how-to/connect-testnet.md + - Connect to Testnets: cdk/how-to/connect-testnet.md - Concepts: - - Full Execution Proofs (FEP): cdk/concepts/full-execution-proofs.md - - Pessimistic Proofs (PP): cdk/concepts/pessimistic-proofs.md - - Layer 2s: cdk/concepts/layer2s.md - - L2 Architecture Overview: cdk/concepts/architecture.md - - L2 Transaction Lifecycle: cdk/concepts/transaction-lifecycle.md - Rollups vs. Validiums: cdk/concepts/rollup-vs-validium.md - ZK vs. Optimistic Rollups: cdk/concepts/zk-vs-optimistic.md - - Batches, Blocks, Transactions: cdk/concepts/blocks.md - - Transaction Finality: cdk/concepts/transaction-finality.md - - Gas Fees: cdk/concepts/gas-fees.md + - L2 Architecture: cdk/concepts/architecture.md - Bridging & Interoperability: cdk/concepts/bridging.md - - Admin Upgradeability: cdk/concepts/admin-upgradeability.md - - Architecture: - - FEP Overview: cdk/architecture/high-level-views.md - - PP Overview: cdk/architecture/cdk-pp-highlevel-arch.md - - Rollup Overview: cdk/architecture/cdk-zkevm.md - - Validium Overview: cdk/architecture/cdk-validium.md - - Staking the Bridge (STB): cdk/architecture/staking-the-bridge.md - - Glossary: + - Resources: - Glossary: cdk/glossary/index.md - - Additional Resources: - - Third-Party Guides: cdk/resources/third-party-guides.md - - Polygon CDK Repos: cdk/resources/cdk-repo-reference.md + - CDK Repos: cdk/resources/cdk-repo-reference.md - zkEVM: - zkEVM: zkEVM/index.md - Overview: zkEVM/overview.md @@ -393,8 +372,7 @@ nav: - EIP-1559: pos/concepts/transactions/eip-1559.md - EIP-4337: pos/concepts/transactions/eip-4337.md - Meta transactions: pos/concepts/transactions/meta-transactions.md - - Miden: - - Miden: miden/index.md + - Miden: "https://0xpolygonmiden.github.io/miden-docs/" - Developer tools: - Developer tools: tools/index.md - Start building: @@ -695,4 +673,4 @@ extra_javascript: - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?version=4.8.0 - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js - - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js + - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js \ No newline at end of file From 825bc6cb2757fa6db677ed7dca199dafdc0dec5b Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Fri, 28 Mar 2025 09:47:49 -0400 Subject: [PATCH 02/11] Update mkdocs.yml --- mkdocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index edfd47453..9f925aaa5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,15 +57,15 @@ nav: - Quickstart: cdk/getting-started/local-deployment.md - CLI Tool: cdk/getting-started/cli-tool.md - Stacks: - - CDK Erigon: + - CDK erigon: - Overview: cdk/getting-started/cdk-erigon/index.md - Architecture: cdk/architecture/cdk-zkevm.md - Release Notes: cdk/getting-started/cdk-erigon/release.md - How To: - Deploy a Node: cdk/getting-started/cdk-erigon/deploy-cdk-erigon.md - Configure Chains Dynamically: cdk/getting-started/cdk-erigon/chain-config.md - - Migration Guide: cdk/how-to/migrate/fork.md - - CDK OP-Geth: + - Migration Guide: cdk/how-to/migrate/forkid-9-12.md + - CDK op-geth: - Overview: cdk/stacks/cdk-opgeth/index.md - Architecture: cdk/stacks/cdk-opgeth/architecture.md - How To: From 0ec67b425a78e4dbe18e23bc2ebbf229e209d497 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 08:13:05 -0400 Subject: [PATCH 03/11] Update mkdocs.yml --- mkdocs.yml | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9f925aaa5..23183731d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,23 +51,26 @@ theme: nav: - Home: index.md - Agglayer: "https://docs.agglayer.dev" - - CDK: - - Polygon CDK Overview: cdk/overview.md + - Polygon CDK: + - Overview: cdk/overview.md - Get Started: - Quickstart: cdk/getting-started/local-deployment.md - CLI Tool: cdk/getting-started/cli-tool.md - Stacks: - - CDK erigon: - - Overview: cdk/getting-started/cdk-erigon/index.md - - Architecture: cdk/architecture/cdk-zkevm.md - - Release Notes: cdk/getting-started/cdk-erigon/release.md + - CDK Erigon: + - Overview: cdk/stacks/cdk-erigon/index.md + - Architecture: cdk/stacks/cdk-erigon/architecture.md + - Release Notes: cdk/stacks/cdk-erigon/release.md - How To: - - Deploy a Node: cdk/getting-started/cdk-erigon/deploy-cdk-erigon.md - - Configure Chains Dynamically: cdk/getting-started/cdk-erigon/chain-config.md - - Migration Guide: cdk/how-to/migrate/forkid-9-12.md + - Deploy a Node: cdk/stacks/cdk-erigon/deploy-cdk-erigon.md + - Configure Chains Dynamically: cdk/stacks/cdk-erigon/chain-config.md + - Migration Guide: cdk/stacks/cdk-erigon/migrate-forkid-9-12.md - CDK op-geth: - Overview: cdk/stacks/cdk-opgeth/index.md - Architecture: cdk/stacks/cdk-opgeth/architecture.md + - Release Notes: cdk/stacks/cdk-opgeth/release.md + - How To: + - Deploy a Node: cdk/stacks/cdk-opgeth/deploy-cdk-opgeth.md - How To: - Create a Native Token: cdk/how-to/use-native-token.md - Integrate DA Layer: cdk/how-to/integrate-da.md From 7e3dd6f01d4a996f266b31a3089fcfaace77ff3f Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 08:21:43 -0400 Subject: [PATCH 04/11] Update mkdocs.yml --- mkdocs.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 23183731d..4b7bc7155 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,13 @@ nav: - Quickstart: cdk/getting-started/local-deployment.md - CLI Tool: cdk/getting-started/cli-tool.md - Stacks: - - CDK Erigon: + - CDK-opgeth: + - Overview: cdk/stacks/cdk-opgeth/index.md + - Architecture: cdk/stacks/cdk-opgeth/architecture.md + - Release Notes: cdk/stacks/cdk-opgeth/release.md + - How To: + - Deploy a Node: cdk/stacks/cdk-opgeth/deploy-cdk-opgeth.md + - CDK-erigon: - Overview: cdk/stacks/cdk-erigon/index.md - Architecture: cdk/stacks/cdk-erigon/architecture.md - Release Notes: cdk/stacks/cdk-erigon/release.md @@ -65,12 +71,6 @@ nav: - Deploy a Node: cdk/stacks/cdk-erigon/deploy-cdk-erigon.md - Configure Chains Dynamically: cdk/stacks/cdk-erigon/chain-config.md - Migration Guide: cdk/stacks/cdk-erigon/migrate-forkid-9-12.md - - CDK op-geth: - - Overview: cdk/stacks/cdk-opgeth/index.md - - Architecture: cdk/stacks/cdk-opgeth/architecture.md - - Release Notes: cdk/stacks/cdk-opgeth/release.md - - How To: - - Deploy a Node: cdk/stacks/cdk-opgeth/deploy-cdk-opgeth.md - How To: - Create a Native Token: cdk/how-to/use-native-token.md - Integrate DA Layer: cdk/how-to/integrate-da.md From ed1cb3a6fa60b1420bee48d8df6550e73efa27e7 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 08:52:44 -0400 Subject: [PATCH 05/11] removing nav items --- .../{local-deployment.md => quickstart.md} | 0 docs/cdk/index.md | 70 ------------------- docs/cdk/releases/release-notes.md | 24 ------- .../index.md => resources/cdk-glossary.md} | 0 .../cdk-erigon/chain-config.md | 0 .../cdk-erigon/deploy-cdk-erigon.md | 0 .../cdk-erigon/index.md | 0 .../cdk-erigon/network-recovery.md | 0 .../cdk-erigon/release-notes.md} | 0 .../cdk-erigon/resources.md | 0 .../cdk-pp-highlevel-arch.md | 0 .../{architecture => stacks}/cdk-validium.md | 0 .../cdk/{architecture => stacks}/cdk-zkevm.md | 0 .../high-level-views.md | 0 .../staking-the-bridge.md | 0 .../type-1-prover/intro-t1-prover.md | 0 .../type-1-prover/t1-architecture.md | 0 .../type-1-prover/t1-cpu-component.md | 0 .../type-1-prover/t1-ctl-protocol.md | 0 .../type-1-prover/t1-design-challenge.md | 0 .../type-1-prover/t1-rangechecks.md | 0 .../testing-and-proving-costs.md | 0 mkdocs.yml | 14 ++-- 23 files changed, 7 insertions(+), 101 deletions(-) rename docs/cdk/getting-started/{local-deployment.md => quickstart.md} (100%) delete mode 100644 docs/cdk/index.md delete mode 100644 docs/cdk/releases/release-notes.md rename docs/cdk/{glossary/index.md => resources/cdk-glossary.md} (100%) rename docs/cdk/{getting-started => stacks}/cdk-erigon/chain-config.md (100%) rename docs/cdk/{getting-started => stacks}/cdk-erigon/deploy-cdk-erigon.md (100%) rename docs/cdk/{getting-started => stacks}/cdk-erigon/index.md (100%) rename docs/cdk/{getting-started => stacks}/cdk-erigon/network-recovery.md (100%) rename docs/cdk/{getting-started/cdk-erigon/release.md => stacks/cdk-erigon/release-notes.md} (100%) rename docs/cdk/{getting-started => stacks}/cdk-erigon/resources.md (100%) rename docs/cdk/{architecture => stacks}/cdk-pp-highlevel-arch.md (100%) rename docs/cdk/{architecture => stacks}/cdk-validium.md (100%) rename docs/cdk/{architecture => stacks}/cdk-zkevm.md (100%) rename docs/cdk/{architecture => stacks}/high-level-views.md (100%) rename docs/cdk/{architecture => stacks}/staking-the-bridge.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/intro-t1-prover.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/t1-architecture.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/t1-cpu-component.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/t1-ctl-protocol.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/t1-design-challenge.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/t1-rangechecks.md (100%) rename docs/cdk/{architecture => stacks}/type-1-prover/testing-and-proving-costs.md (100%) diff --git a/docs/cdk/getting-started/local-deployment.md b/docs/cdk/getting-started/quickstart.md similarity index 100% rename from docs/cdk/getting-started/local-deployment.md rename to docs/cdk/getting-started/quickstart.md diff --git a/docs/cdk/index.md b/docs/cdk/index.md deleted file mode 100644 index 857cd636c..000000000 --- a/docs/cdk/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -hide: - - toc ---- - - - -
-
-
-

Polygon CDK

-

Polygon Chain Development Kit (CDK) is a modular, open-source blockchain stack for developers launching sovereign L2 chains powered by zero-knowledge (ZK) proofs.

-
-
-
- -
-
- -
-
Understand the CDK
-
-

A high-level overview of the CDK, its features and benefits.

- -
-
- -
-
Try out the CDK locally
-
-

Get started by deploying a chain on your local machine.

- -
-
- -
-
CDK concepts
-
-

Learn about the concepts behind the CDK.

- -
-
- -
-
CDK architecture
-
-

Dive deeper into the components of a CDK chain and how they interact.

- -
-
- -
-
Contribute to the CDK
-
-

Get involved in building the open-source CDK stack on GitHub.

- -
-
- -
-
Join the dev community
-
-

Join our developer Discord server to ask questions and get help.

- -
-
diff --git a/docs/cdk/releases/release-notes.md b/docs/cdk/releases/release-notes.md deleted file mode 100644 index ceefaf457..000000000 --- a/docs/cdk/releases/release-notes.md +++ /dev/null @@ -1,24 +0,0 @@ -_Last updated: December 2024_ - -Fork ID 12 brings significant updates to the Polygon CDK stack, enhancing performance, scalability, and the developer experience. This release focuses on improvements across the client layer, proving systems, and developer tooling, making it easier to build and operate high-performance Layer 2 chains. - ---- - -### Key Updates - -#### Erigon Integration -- Faster syncing for quicker chain setup and operation. -- Improved transaction throughput and resource efficiency. -- Full compatibility with Ethereum tools and infrastructure. - -#### Proving System Enhancements -- Increased capacity for handling complex transactions and higher volumes. -- Faster proof generation for quicker deployment and smoother operations. - -#### Developer Tooling Improvements -- Simplified CLI for easier chain deployment and configuration. -- Updated documentation with improved guides for developers. - -#### Full Execution Proofs -- Comprehensive validation: Verifies that all state transitions executed by the underlying VM (such as Polygon zkEVM) adhere to the protocol’s specifications. -- Flexibility across modes: Supports both rollup and validium modes, providing scalability and security tailored to different use cases. diff --git a/docs/cdk/glossary/index.md b/docs/cdk/resources/cdk-glossary.md similarity index 100% rename from docs/cdk/glossary/index.md rename to docs/cdk/resources/cdk-glossary.md diff --git a/docs/cdk/getting-started/cdk-erigon/chain-config.md b/docs/cdk/stacks/cdk-erigon/chain-config.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/chain-config.md rename to docs/cdk/stacks/cdk-erigon/chain-config.md diff --git a/docs/cdk/getting-started/cdk-erigon/deploy-cdk-erigon.md b/docs/cdk/stacks/cdk-erigon/deploy-cdk-erigon.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/deploy-cdk-erigon.md rename to docs/cdk/stacks/cdk-erigon/deploy-cdk-erigon.md diff --git a/docs/cdk/getting-started/cdk-erigon/index.md b/docs/cdk/stacks/cdk-erigon/index.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/index.md rename to docs/cdk/stacks/cdk-erigon/index.md diff --git a/docs/cdk/getting-started/cdk-erigon/network-recovery.md b/docs/cdk/stacks/cdk-erigon/network-recovery.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/network-recovery.md rename to docs/cdk/stacks/cdk-erigon/network-recovery.md diff --git a/docs/cdk/getting-started/cdk-erigon/release.md b/docs/cdk/stacks/cdk-erigon/release-notes.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/release.md rename to docs/cdk/stacks/cdk-erigon/release-notes.md diff --git a/docs/cdk/getting-started/cdk-erigon/resources.md b/docs/cdk/stacks/cdk-erigon/resources.md similarity index 100% rename from docs/cdk/getting-started/cdk-erigon/resources.md rename to docs/cdk/stacks/cdk-erigon/resources.md diff --git a/docs/cdk/architecture/cdk-pp-highlevel-arch.md b/docs/cdk/stacks/cdk-pp-highlevel-arch.md similarity index 100% rename from docs/cdk/architecture/cdk-pp-highlevel-arch.md rename to docs/cdk/stacks/cdk-pp-highlevel-arch.md diff --git a/docs/cdk/architecture/cdk-validium.md b/docs/cdk/stacks/cdk-validium.md similarity index 100% rename from docs/cdk/architecture/cdk-validium.md rename to docs/cdk/stacks/cdk-validium.md diff --git a/docs/cdk/architecture/cdk-zkevm.md b/docs/cdk/stacks/cdk-zkevm.md similarity index 100% rename from docs/cdk/architecture/cdk-zkevm.md rename to docs/cdk/stacks/cdk-zkevm.md diff --git a/docs/cdk/architecture/high-level-views.md b/docs/cdk/stacks/high-level-views.md similarity index 100% rename from docs/cdk/architecture/high-level-views.md rename to docs/cdk/stacks/high-level-views.md diff --git a/docs/cdk/architecture/staking-the-bridge.md b/docs/cdk/stacks/staking-the-bridge.md similarity index 100% rename from docs/cdk/architecture/staking-the-bridge.md rename to docs/cdk/stacks/staking-the-bridge.md diff --git a/docs/cdk/architecture/type-1-prover/intro-t1-prover.md b/docs/cdk/stacks/type-1-prover/intro-t1-prover.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/intro-t1-prover.md rename to docs/cdk/stacks/type-1-prover/intro-t1-prover.md diff --git a/docs/cdk/architecture/type-1-prover/t1-architecture.md b/docs/cdk/stacks/type-1-prover/t1-architecture.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/t1-architecture.md rename to docs/cdk/stacks/type-1-prover/t1-architecture.md diff --git a/docs/cdk/architecture/type-1-prover/t1-cpu-component.md b/docs/cdk/stacks/type-1-prover/t1-cpu-component.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/t1-cpu-component.md rename to docs/cdk/stacks/type-1-prover/t1-cpu-component.md diff --git a/docs/cdk/architecture/type-1-prover/t1-ctl-protocol.md b/docs/cdk/stacks/type-1-prover/t1-ctl-protocol.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/t1-ctl-protocol.md rename to docs/cdk/stacks/type-1-prover/t1-ctl-protocol.md diff --git a/docs/cdk/architecture/type-1-prover/t1-design-challenge.md b/docs/cdk/stacks/type-1-prover/t1-design-challenge.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/t1-design-challenge.md rename to docs/cdk/stacks/type-1-prover/t1-design-challenge.md diff --git a/docs/cdk/architecture/type-1-prover/t1-rangechecks.md b/docs/cdk/stacks/type-1-prover/t1-rangechecks.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/t1-rangechecks.md rename to docs/cdk/stacks/type-1-prover/t1-rangechecks.md diff --git a/docs/cdk/architecture/type-1-prover/testing-and-proving-costs.md b/docs/cdk/stacks/type-1-prover/testing-and-proving-costs.md similarity index 100% rename from docs/cdk/architecture/type-1-prover/testing-and-proving-costs.md rename to docs/cdk/stacks/type-1-prover/testing-and-proving-costs.md diff --git a/mkdocs.yml b/mkdocs.yml index 4b7bc7155..bdefda5af 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,18 +61,18 @@ nav: - Overview: cdk/stacks/cdk-opgeth/index.md - Architecture: cdk/stacks/cdk-opgeth/architecture.md - Release Notes: cdk/stacks/cdk-opgeth/release.md - - How To: - - Deploy a Node: cdk/stacks/cdk-opgeth/deploy-cdk-opgeth.md - CDK-erigon: - Overview: cdk/stacks/cdk-erigon/index.md - Architecture: cdk/stacks/cdk-erigon/architecture.md - Release Notes: cdk/stacks/cdk-erigon/release.md - - How To: - - Deploy a Node: cdk/stacks/cdk-erigon/deploy-cdk-erigon.md - - Configure Chains Dynamically: cdk/stacks/cdk-erigon/chain-config.md - - Migration Guide: cdk/stacks/cdk-erigon/migrate-forkid-9-12.md - How To: - - Create a Native Token: cdk/how-to/use-native-token.md + - CDK-opgeth: + - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md + - CDK-erigon: + - Deploy a Node: cdk/how-to/cdk-erigon/deploy-cdk-erigon.md + - Create a Native Gas Token: cdk/how-to/cdk-erigon/use-native-token.md + - Configure Chains Dynamically: cdk/how-to/cdk-erigon/chain-config.md + - Migration Guide: cdk/how-to/cdk-erigon/migrate-forkid-9-12.md - Integrate DA Layer: cdk/how-to/integrate-da.md - Connect to Testnets: cdk/how-to/connect-testnet.md - Concepts: From 0013b791487a8a668d4455932c153f0e2c3a80aa Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 09:26:59 -0400 Subject: [PATCH 06/11] Update mkdocs.yml --- mkdocs.yml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index bdefda5af..b63c25637 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,20 +61,17 @@ nav: - Overview: cdk/stacks/cdk-opgeth/index.md - Architecture: cdk/stacks/cdk-opgeth/architecture.md - Release Notes: cdk/stacks/cdk-opgeth/release.md + - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md - CDK-erigon: - Overview: cdk/stacks/cdk-erigon/index.md - Architecture: cdk/stacks/cdk-erigon/architecture.md - Release Notes: cdk/stacks/cdk-erigon/release.md - - How To: - - CDK-opgeth: - - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md - - CDK-erigon: - Deploy a Node: cdk/how-to/cdk-erigon/deploy-cdk-erigon.md - Create a Native Gas Token: cdk/how-to/cdk-erigon/use-native-token.md - Configure Chains Dynamically: cdk/how-to/cdk-erigon/chain-config.md - Migration Guide: cdk/how-to/cdk-erigon/migrate-forkid-9-12.md - - Integrate DA Layer: cdk/how-to/integrate-da.md - - Connect to Testnets: cdk/how-to/connect-testnet.md + - Integrate DA Layer: cdk/how-to/integrate-da.md + - Connect to Testnets: cdk/how-to/connect-testnet.md - Concepts: - Rollups vs. Validiums: cdk/concepts/rollup-vs-validium.md - ZK vs. Optimistic Rollups: cdk/concepts/zk-vs-optimistic.md From a0abc043a63e6a08a2c06bada9a54d346a732103 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 09:48:51 -0400 Subject: [PATCH 07/11] Update mkdocs.yml --- mkdocs.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index b63c25637..1589b9c47 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,11 +72,6 @@ nav: - Migration Guide: cdk/how-to/cdk-erigon/migrate-forkid-9-12.md - Integrate DA Layer: cdk/how-to/integrate-da.md - Connect to Testnets: cdk/how-to/connect-testnet.md - - Concepts: - - Rollups vs. Validiums: cdk/concepts/rollup-vs-validium.md - - ZK vs. Optimistic Rollups: cdk/concepts/zk-vs-optimistic.md - - L2 Architecture: cdk/concepts/architecture.md - - Bridging & Interoperability: cdk/concepts/bridging.md - Resources: - Glossary: cdk/glossary/index.md - CDK Repos: cdk/resources/cdk-repo-reference.md From 9909884ddb2a886a4e8c80490d7a2dafb9cda1f0 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 11:36:22 -0400 Subject: [PATCH 08/11] Update mkdocs.yml --- mkdocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 1589b9c47..2086f76bf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,17 +53,20 @@ nav: - Agglayer: "https://docs.agglayer.dev" - Polygon CDK: - Overview: cdk/overview.md - - Get Started: - Quickstart: cdk/getting-started/local-deployment.md - CLI Tool: cdk/getting-started/cli-tool.md - Stacks: - CDK-opgeth: - Overview: cdk/stacks/cdk-opgeth/index.md + - Quickstart: + - CLI Tool: - Architecture: cdk/stacks/cdk-opgeth/architecture.md - Release Notes: cdk/stacks/cdk-opgeth/release.md - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md - CDK-erigon: - Overview: cdk/stacks/cdk-erigon/index.md + - Quickstart: cdk/getting-started/local-deployment.md + - CLI Tool: cdk/getting-started/cli-tool.md - Architecture: cdk/stacks/cdk-erigon/architecture.md - Release Notes: cdk/stacks/cdk-erigon/release.md - Deploy a Node: cdk/how-to/cdk-erigon/deploy-cdk-erigon.md From 5c2f6e3bf4d51407658047e4ac5ce17677c399ab Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 11:38:18 -0400 Subject: [PATCH 09/11] Update mkdocs.yml --- mkdocs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2086f76bf..f2ffe3a6e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,8 +58,6 @@ nav: - Stacks: - CDK-opgeth: - Overview: cdk/stacks/cdk-opgeth/index.md - - Quickstart: - - CLI Tool: - Architecture: cdk/stacks/cdk-opgeth/architecture.md - Release Notes: cdk/stacks/cdk-opgeth/release.md - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md From 621d51e53af9cd08a172bc1e790db61ca98b4743 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Thu, 3 Apr 2025 11:40:50 -0400 Subject: [PATCH 10/11] updates to nav --- docs/cdk/overview.md | 47 ++------------------------------------------ mkdocs.yml | 2 -- 2 files changed, 2 insertions(+), 47 deletions(-) diff --git a/docs/cdk/overview.md b/docs/cdk/overview.md index 369f6dd4a..368bd88bb 100644 --- a/docs/cdk/overview.md +++ b/docs/cdk/overview.md @@ -10,49 +10,6 @@ Polygon CDK allows developers to build scalable and customizable Layer 2 blockch --- -### Why Should Developers Care? +### What Stack Should You Choose? -- **Low costs and high performance**: Polygon CDK chains offer lower transaction fees and faster finality compared to Ethereum Layer 1 and many Layer 2 solutions. -- **Seamless cross-chain interoperability**: With Agglayer integration (currently in testnet), Polygon CDK chains can interact securely with other chains and external networks. -- **Modular and future-ready**: Developers can customize their chain’s architecture to meet specific use cases, ensuring compatibility with emerging technologies. -- **Ethereum-compatible**: Polygon CDK supports EVM tooling, ensuring a smooth developer experience and easy migration for existing applications. - ---- - -### How Does It Work? - -Polygon CDK simplifies the process of building Layer 2 blockchains by providing pre-built components of a chain. Here’s how it works at a high level: - -#### Execution Layer - -- Sequencer Nodes: Handle transaction ordering and provide RPC (Remote Procedure Call) endpoints for interacting with the chain. -- Prover: Ensures transaction validity and supports zk-Rollup configs by generating cryptographic proofs. Developers can use any prover suited to their needs. -- Pool Manager: Optimizes resource allocation for chains to efficiently process transactions. - -#### Data Availability - -- Ethereum DA: Stores transaction data directly on Ethereum for zk-Rollup configs, ensuring security and decentralization. -- Custom DAC: An off-chain solution for Validium configs, offering scalability and cost-efficiency while maintaining data integrity. -- Agglayer Pessimistic Proofs: Provides security and enables cross-chain functionality for Sovereign configs without requiring zk-SNARKs or on-chain data storage. - -#### Settlement Layer - -- Ethereum Bridge Contracts: Used by zk-Rollup configs to finalize transactions on Ethereum. -- Agglayer Integration: Sovereign configs settle transactions and enable interoperability through Agglayer using cryptographic pessimistic proofs. - -#### Sequencer - -- Sequence Sender: Ensures proper transaction ordering and maintains data integrity. - -#### Interoperability - -- Bridge APIs: Enable cross-chain transfers of assets and data, connecting Polygon CDK chains with Ethereum and other Layer 2s. -- Aggregator: Combines multiple proofs into a single proof for zk-Rollup configs to optimize validation. - ---- - -### A Note on Configurations - -Polygon CDK supports three main configurations—zk-Rollup, Validium, and Sovereign—which align with the most common Layer 2 use cases. These configurations use a standard set of components optimized for scalability, security, and interoperability. - -While most developers rely on these configurations for simplicity, the stack is fully modular and customizable, allowing teams to adjust or replace components to create a Layer 2 chain tailored to their specific requirements. \ No newline at end of file +--- \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f2ffe3a6e..27cc6d553 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,8 +53,6 @@ nav: - Agglayer: "https://docs.agglayer.dev" - Polygon CDK: - Overview: cdk/overview.md - - Quickstart: cdk/getting-started/local-deployment.md - - CLI Tool: cdk/getting-started/cli-tool.md - Stacks: - CDK-opgeth: - Overview: cdk/stacks/cdk-opgeth/index.md From 9ea392ea23583c02e1f280680cef24d2c111f462 Mon Sep 17 00:00:00 2001 From: mitchpolygon Date: Tue, 15 Apr 2025 10:20:21 -0400 Subject: [PATCH 11/11] Update mkdocs.yml --- mkdocs.yml | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 27cc6d553..eb20f0743 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,25 +52,24 @@ nav: - Home: index.md - Agglayer: "https://docs.agglayer.dev" - Polygon CDK: - - Overview: cdk/overview.md - - Stacks: - - CDK-opgeth: - - Overview: cdk/stacks/cdk-opgeth/index.md - - Architecture: cdk/stacks/cdk-opgeth/architecture.md - - Release Notes: cdk/stacks/cdk-opgeth/release.md - - Deploy a Node: cdk/how-to/cdk-opgeth/deploy-cdk-opgeth.md - - CDK-erigon: - - Overview: cdk/stacks/cdk-erigon/index.md - - Quickstart: cdk/getting-started/local-deployment.md - - CLI Tool: cdk/getting-started/cli-tool.md - - Architecture: cdk/stacks/cdk-erigon/architecture.md - - Release Notes: cdk/stacks/cdk-erigon/release.md - - Deploy a Node: cdk/how-to/cdk-erigon/deploy-cdk-erigon.md - - Create a Native Gas Token: cdk/how-to/cdk-erigon/use-native-token.md - - Configure Chains Dynamically: cdk/how-to/cdk-erigon/chain-config.md - - Migration Guide: cdk/how-to/cdk-erigon/migrate-forkid-9-12.md - - Integrate DA Layer: cdk/how-to/integrate-da.md - - Connect to Testnets: cdk/how-to/connect-testnet.md + - Overview: + - What is Polygon CDK?: cdk/overview.md + - What is Polygon CDK-opgeth?: cdk/stacks/cdk-opgeth/index.md + - What is Polygon CDK-erigon?: cdk/stacks/cdk-erigon/index.md + - Why Use CDK?: cdk/overview/why-cdk.md + - Overview of Benefits: cdk/overview/benefits.md + - What Configuration Should I Choose?: cdk/overview/configuration.md + - FAQs: cdk/overview/faqs.md + - CDK-opgeth: + - Get Started: cdk/opgeth/get-started.md # Tabs: Quickstart, CLI Tool, Deploy a Node, Connect to Testnets + - CDK-erigon: + - Get Started: cdk/erigon/get-started.md # Tabs: Quickstart, CLI Tool, Deploy a Node, Connect to Testnets + - Migration Guide: + - Fork ID 9 to 12: cdk/how-to/cdk-erigon/migrate-forkid-9-12.md + - Concepts: + - Layer 2 Basics: cdk/concepts/layer2-basics.md + - Rollups vs. Validiums: cdk/concepts/rollups-validiums.md + - Bridging & Interoperability: cdk/concepts/bridging-interoperability.md - Resources: - Glossary: cdk/glossary/index.md - CDK Repos: cdk/resources/cdk-repo-reference.md