first iteration of edit

Author: Niramisa Weiss

docs/technology/cdk/component-repos.md

@@ -0,0 +1,9 @@
+
+| Component                                                                     | Description                                                          |
+| ----------------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| [CDK validium node](https://github.com/0xPolygon/cdk-validium-node)           | Node implementation for the CDK networks in Validium mode            |
+| [CDK validium contracts](https://github.com/0xPolygon/cdk-validium-contracts) | Smart contracts implementation for the CDK networks in Validium mode |
+| [CDK data availability layer](https://github.com/0xPolygon/cdk-data-availability)   | Data availability nodes implementation for the CDK networks          |
+| [Prover/Executor](https://github.com/0xPolygonHermez/zkevm-prover)          | zkEVM engine and prover implementation                               |
+| [Bridge service](https://github.com/0xPolygonHermez/zkevm-bridge-service)     | Bridge service implementation for CDK networks                       |
+| [Bridge UI](https://github.com/0xPolygonHermez/zkevm-bridge-ui)               | UI for the CDK networks bridge                                       |

docs/technology/cdk/deployment-differences.md

@@ -0,0 +1,36 @@
+!!! info 
+    Polygon CDK is in public preview stage and subject to changes.
+
+
+!!! warning
+    The CDK in validium mode is in active development, with ongoing feature enhancements and issue resolutions. 
+    
+    For the latest updates, follow our official GitHub repositories.
+
+    - [Node](https://github.com/0xPolygon/cdk-validium-node)
+    - [Data Availability](https://github.com/0xPolygon/cdk-data-availability)
+    - [Contracts](https://github.com/0xPolygon/cdk-validium-contracts)
+
+
+!!! important "Recommendation"
+    Follow the [Quickstart](quickstart.md) for a hands-on introduction to CDK in validium mode.
+
+Follow the steps below to deploy a CDK validium instance.
+
+## 1. Deploy validium-specific contracts
+
+First, deploy the relevant contracts.
+
+Follow the steps in the [CDK validium contracts repository's README</ins>](https://github.com/0xPolygon/cdk-validium-contracts).
+
+## 2. Run the CDK validium node
+
+Next, set up and run the CDK validium node. 
+
+Follow the instructions in the [CDK validium node repository's README](https://github.com/0xPolygon/cdk-validium-node).
+
+## 3. Run the data availability (DA) node
+
+Finally, once the CDK validium node is operational, set up and run the data availability node. 
+
+Instructions for this can be found in the [<ins>CDK DA Node GitHub repository's README</ins>](https://github.com/0xPolygon/cdk-data-availability).

docs/technology/cdk/deployment-validium.md

@@ -1,67 +1,50 @@
----
-id: allowlists
-title: CDK Validium Allowlists
-sidebar_label: Allowlists
-description: "Learn about allowlists and access control in the Polygon CDK."
-keywords:
-  - docs
-  - polygon
-  - layer 2
-  - validium
-  - allowlist
-  - access
-  - access control
-  - acl
----
-
-The CDK Validium node offers policy management features, including allowlisting and Access Control Lists (ACLs). These features are particularly beneficial for Validium-based app-chains that require fine-grained control over transaction pools. It is the Sequencer node that enforces these policies, and any change operations should be applied directly through the Sequencer. This document provides an overview on these administrative capabilities and explains how to use them.
-
-## Key Concepts
-
-- **Policy**: A set of rules that govern what actions are allowed or denied in the transaction pool. Currently, there are two defined policies:
-   - **SendTx**: Governs whether an address may send transactions to the pool.
-   - **Deploy**: Governs whether an address may deploy a contract.
-- **ACL (Access Control List)**: A list of addresses that are exceptions to a given policy.
-- **Allowlisting**: The process of explicitly allowing addresses to perform certain actions.
-- **Denylisting**: The process of explicitly denying addresses from performing certain actions.
+## Validium node
+
+A **policy** is a set of rules that govern what actions are allowed or denied in the transaction pool. Currently, there are two defined policies:
+
+- **SendTx**: governs whether an address may send transactions to the pool.
+- **Deploy**: governs whether an address may deploy a contract.
+
+The CDK validium node offers policy management features that include allowlisting[^1], denylisting[^2], and access control lists (ACLs)[^3]. These features are beneficial for validium-based app-chains that require fine-grained control over transaction pools. 
 
 ## Architecture
 
 The architecture is divided into the following main components:
 
-- **Policy Management Layer**: Defined in `policy.go`, this layer is responsible for the core logic of policy management.
-- **Data Layer**: Defined in `pgpoolstorage/policy.go`, this layer interacts with the data layer (PostgreSQL database) to store and retrieve policy and ACL data.
-- **Policy Definitions**: Defined in `pool/policy.go`, this layer contains the data structures and utility functions for policies and ACLs.
-- **Policy Interface**: Defined in `pool/interfaces.go`, this interface outlines the methods that any concrete type must implement to be considered a policy in the system.
+- **Policy management layer**: Defined in `policy.go`, this layer is responsible for the core logic of policy management.
+- **Data layer**: Defined in `pgpoolstorage/policy.go`, this layer interacts with the data layer (PostgreSQL database) to store and retrieve policy and ACL data.
+- **Policy definitions**: Defined in `pool/policy.go`, this layer contains the data structures and utility functions for policies and ACLs.
+- **Policy interface**: Defined in `pool/interfaces.go`, this interface outlines the methods that any concrete type must implement to be considered a policy in the system.
 
-## Capabilities
+## Policy features
 
-- **Fine-Grained Control**: Developers can specify policies at a granular level, allowing or denying specific actions for specific addresses.
-- **Dynamic Updates**: Policies and ACLs can be updated on-the-fly without requiring a node restart.
-- **Database-Backed**: All policy data is stored in a PostgreSQL database.
+- **Fine-grained control**: Developers can specify policies at a granular level, allowing or denying specific actions for specific addresses.
+- **Dynamic updates**: Policies and ACLs can be updated on-the-fly without requiring a node restart.
+- **Database-backed**: All policy data is stored in a PostgreSQL database.
 - **Extensible**: New policies can be easily added to the system.
 
-## How to Use Policies
+## Instructions for using policies
 
-| Command Name | Description                                           | Flags & Parameters                                                                                      |
+| Command name | Description                                           | Flags & parameters                                                                                      |
 |--------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
 | `policy add` | Add address(es) to a policy exclusion list            | `--policy` (or `-p`): Policy name<br/>`--csv`: CSV file with addresses                                  |
 | `policy remove` | Remove address(es) from a policy exclusion list     | `--policy` (or `-p`): Policy name<br/>`--csv`: CSV file with addresses to remove                        |
 | `policy clear`  | Clear all addresses from a policy's exclusion list  | `--policy` (or `-p`): Policy name                                                                       |
 | `policy describe` | Describe the default actions for the policies or a specific policy | `--policy` (or `-p`): Policy name (optional)<br/>`--no-header`: Omit header in output (optional)      |
 | `policy update`  | Update the default action for a policy             | `--policy` (or `-p`): Policy name<br/>`--allow`: Set policy to 'allow'<br/>`--deny`: Set policy to 'deny' |
 
-We will use the "deploy" policy as an example.
+!!! note
+    For the examples, we are using a `deploy` policy.
 
-### Adding Addresses to a Policy
+### Add addresses to a policy
 
 To add one or more addresses to a specific policy, you can use the `policy add` command. If you have a CSV file containing the addresses, you can use the --csv` flag.
 
 ```bash
 docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy add --policy deploy 0xAddress1
 ```
 
-### Removing Addresses from a Policy
+### Remove addresses from a policy
 
 To remove addresses from a policy, you can use the `policy remove` command.
 
@@ -73,15 +56,15 @@ docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy remove --p
 docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy remove --policy deploy --csv addresses.csv
 ```
 
-### Clearing All Addresses from a Policy
+### Clear all addresses from a policy
 
 To remove all addresses from a policy's ACL, you can use the `policy clear` command.
 
 ```bash
 docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy clear --policy deploy
 ```
 
-### Describing Policies
+### Describing policies
 
 To get information about a specific policy or all policies, you can use the `policy describe` command.
 
@@ -92,3 +75,8 @@ docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy describe -
 # Describe all policies
 docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy describe
 ```
+
+
+[^1]: **Allowlisting**: The process of explicitly allowing addresses to perform certain actions.
+[^2]: **Denylisting**: The process of explicitly denying addresses from performing certain actions.
+[^3]: **ACL (access control list)**: A list of addresses that are exceptions to a given policy.

docs/technology/cdk/allowlists.md …technology/cdk/how-to/manage-policies.mddocs/technology/cdk/allowlists.md renamed to docs/technology/cdk/how-to/manage-policies.md docs/technology/cdk/allowlists.md renamed to docs/technology/cdk/how-to/manage-policies.md

@@ -0,0 +1 @@
+New doc in progress.