feat: update docs

agglayer · Jan 22, 2025 · 2ff21b3 · 2ff21b3
1 parent f885a7a
commit 2ff21b3
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 93 deletions.
diff --git a/book.toml b/book.toml
@@ -11,4 +11,4 @@ command = "mdbook-mermaid"
 [output.html]
 additional-js = ["docs/assets/mermaid.min.js", "docs/assets/mermaid-init.js"]
 
-[preprocessor.alerts]
+[preprocessor.alerts]
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -2,5 +2,5 @@
 
 - [Getting Started](./getting_started.md)
     - [Local Debug](./local_debug.md)
-- [Non-EVM integrations](./non_evm_integration.md)
 - [AggOracle](./aggoracle.md)
+- [Release lifecycle](./release_lifecycle.md)
diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -1,17 +1,3 @@
-# Welcome to Polygon CDK Tech Docs
+# Welcome to Polygon Aggkit Tech Docs
 
-Welcome to the official documentation for the Polygon CDK (Chain Development Kit). This guide will help you get started with building and deploying rollups using the Polygon CDK.
-
-## Getting Started
-
-To get started with Polygon CDK, follow these steps:
-1. [Getting Started](getting_started.md)
-
-## Documentation
-
-Explore the comprehensive documentation to understand the various features and capabilities of the Polygon CDK:
-- [3rd party data availability integration](da_integration.md)
-
-## Support
-
-Happy coding with Polygon CDK!
+Welcome to the official documentation for the Polygon Aggkit. This guide will help you get started with building and deploying rollups to the Agglayer.
diff --git a/docs/local_debug.md b/docs/local_debug.md
@@ -6,20 +6,20 @@
 * In `test/scripts/env.sh` setup `KURTOSIS_FOLDER` pointing to your setup.
 
 > [!TIP]
-> Use your WIP branch in Kurtosis as needed
+> Use your WIP branch in Kurtosis CDK as needed
 
-## Create configuration for this kurtosis environment
+## 1. Create configuration for this kurtosis environment
 
-```
+```bash
 scripts/local_config
 ```
 
-## Stop aggkit enclave started by Kurtosis
+## 2. Stop the aggkit node started by Kurtosis CDK
 
 ```bash
 kurtosis service stop aggkit cdk-node-001
 ```
 
-## Add to vscode launch.json
+## 3. Add to vscode launch.json
 
-After execution `scripts/local_config` it suggest an entry for `launch.json` configurations
+After execution of `scripts/local_config`, it suggests an entry for `launch.json` configurations
diff --git a/docs/non_evm_integration.md b/docs/non_evm_integration.md