Index docs

docs/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Documentation",
+    "position": 1,
+    "link": {
+        "type": "generated-index",
+        "description": "Complete documentation for the IC EVM Connect Proxy project"
+    }
+}

docs/components/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Components",
+    "position": 2,
+    "link": {
+        "type": "generated-index",
+        "description": "Detailed documentation for each component of the system"
+    }
+}

docs/components/canisters/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Canisters",
+    "position": 1,
+    "link": {
+        "type": "generated-index",
+        "description": "Documentation for all ICP Canisters in the system"
+    }
+}

docs/components/counter-canister.md → docs/components/canisters/counter-canister.md

@@ -1,3 +1,8 @@
+---
+title: Counter Canister
+sidebar_position: 1
+---
+
 # Counter Canister
 
 The Counter Canister is a Rust-based canister that demonstrates basic functionality on the Internet Computer Protocol (ICP). It now includes both counter operations and basic DEX-like functionality, serving as an example of how to generate events that can be logged and later translated into EVM-compatible formats.

docs/components/dex-canister.md → docs/components/canisters/dex-canister.md

@@ -1,3 +1,8 @@
+---
+title: DEX Canister
+sidebar_position: 2
+---
+
 # DEX Canister
 
 The DEX (Decentralized Exchange) Canister is a Rust-based canister that implements basic decentralized exchange functionality on the Internet Computer Protocol (ICP). It provides trading pair management, token operations, and generates events that are logged using the ICRC-3 standard.

docs/components/logger-canister.md → docs/components/canisters/logger-canister.md

@@ -1,3 +1,8 @@
+---
+title: Logger Canister
+sidebar_position: 3
+---
+
 # Logger Canister
 
 The Logger Canister is a Rust-based canister that implements ICRC-3 compatible logging on the Internet Computer Protocol (ICP). It plays a crucial role in capturing and storing events generated by other canisters, such as the Counter Canister, in a standardized format.

docs/components/evm-adapter-proxy.md

@@ -1,3 +1,8 @@
+---
+title: EVM Adapter Proxy
+sidebar_position: 2
+---
+
 # EVM Adapter Proxy
 
 The EVM Adapter Proxy is a crucial component in the ICP-EVM Proxy project. It serves as a bridge between the Internet Computer Protocol (ICP) and EVM-compatible systems, enabling interoperability and data translation.

docs/components/subquery-indexer.md

@@ -1,3 +1,8 @@
+---
+title: SubQuery Indexer
+sidebar_position: 3
+---
+
 # SubQuery Indexer
 
 The SubQuery Indexer is a crucial component of the ICP-EVM Proxy project, designed to index and make queryable the EVM-compatible data translated by the EVM Adapter Proxy. This Node.js-based service provides a GraphQL API for efficient data retrieval and analysis.

docs/getting-started/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Getting Started",
+    "position": 1,
+    "link": {
+        "type": "generated-index",
+        "description": "Essential information to get started with ICP-EVM Proxy"
+    }
+}

docs/diagram.md → docs/getting-started/architecture.md

@@ -1,3 +1,10 @@
+---
+title: Architecture
+sidebar_position: 2
+---
+
+# Project Modules Architecture
+
 ```mermaid
 graph TD
     User((User))

docs/overview.md → docs/getting-started/overview.md

@@ -1,3 +1,8 @@
+---
+title: Overview
+sidebar_position: 1
+---
+
 # ICP-EVM Proxy Overview
 
 The ICP-EVM Proxy is a proof-of-concept (PoC) project designed to enhance interoperability between the Internet Computer Protocol (ICP) and EVM-compatible platforms. This document provides a high-level overview of the project's components and functionality.

docs/guides/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Guides",
+    "position": 3,
+    "link": {
+        "type": "generated-index",
+        "description": "Step-by-step guides for setup, deployment and usage"
+    }
+}

docs/setup-and-deployment.md → docs/guides/setup-and-deployment.md

@@ -1,3 +1,8 @@
+---
+title: Setup & Deployment
+sidebar_position: 1
+---
+
 # Setup and Deployment
 
 This guide provides instructions for setting up and deploying the ICP-EVM Proxy project components.

docs/usage.md → docs/guides/usage.md

@@ -1,3 +1,8 @@
+---
+title: Usage Guide
+sidebar_position: 2
+---
+
 # Usage Guide for ICP-EVM Proxy
 
 This guide provides instructions on how to interact with the ICP-EVM Proxy system after it has been set up and deployed.