diff --git a/docs/_category_.json b/docs/_category_.json new file mode 100644 index 0000000..8f9aa2b --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/docs/components/_category_.json b/docs/components/_category_.json new file mode 100644 index 0000000..5e86930 --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/docs/components/canisters/_category_.json b/docs/components/canisters/_category_.json new file mode 100644 index 0000000..7cf0465 --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/docs/components/counter-canister.md b/docs/components/canisters/counter-canister.md similarity index 97% rename from docs/components/counter-canister.md rename to docs/components/canisters/counter-canister.md index 81af195..938e265 100644 --- a/docs/components/counter-canister.md +++ b/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. diff --git a/docs/components/dex-canister.md b/docs/components/canisters/dex-canister.md similarity index 98% rename from docs/components/dex-canister.md rename to docs/components/canisters/dex-canister.md index 334f2f0..1bfa1e0 100644 --- a/docs/components/dex-canister.md +++ b/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. diff --git a/docs/components/logger-canister.md b/docs/components/canisters/logger-canister.md similarity index 98% rename from docs/components/logger-canister.md rename to docs/components/canisters/logger-canister.md index c35216b..ff8756d 100644 --- a/docs/components/logger-canister.md +++ b/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. diff --git a/docs/components/evm-adapter-proxy.md b/docs/components/evm-adapter-proxy.md index 65f19a0..be90bc6 100644 --- a/docs/components/evm-adapter-proxy.md +++ b/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. diff --git a/docs/components/subquery-indexer.md b/docs/components/subquery-indexer.md index 45d480e..bb1acc7 100644 --- a/docs/components/subquery-indexer.md +++ b/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. diff --git a/docs/getting-started/_category_.json b/docs/getting-started/_category_.json new file mode 100644 index 0000000..d40817b --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/docs/diagram.md b/docs/getting-started/architecture.md similarity index 92% rename from docs/diagram.md rename to docs/getting-started/architecture.md index f59d0bd..e2495ed 100644 --- a/docs/diagram.md +++ b/docs/getting-started/architecture.md @@ -1,3 +1,10 @@ +--- +title: Architecture +sidebar_position: 2 +--- + +# Project Modules Architecture + ```mermaid graph TD User((User)) diff --git a/docs/overview.md b/docs/getting-started/overview.md similarity index 98% rename from docs/overview.md rename to docs/getting-started/overview.md index 0cda082..5986f25 100644 --- a/docs/overview.md +++ b/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. diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json new file mode 100644 index 0000000..126bb12 --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/docs/setup-and-deployment.md b/docs/guides/setup-and-deployment.md similarity index 98% rename from docs/setup-and-deployment.md rename to docs/guides/setup-and-deployment.md index ab278eb..f1c7bc7 100644 --- a/docs/setup-and-deployment.md +++ b/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. diff --git a/docs/usage.md b/docs/guides/usage.md similarity index 98% rename from docs/usage.md rename to docs/guides/usage.md index 78b1e7d..88d4833 100644 --- a/docs/usage.md +++ b/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.