diff --git a/docs/quick-start/node-operators/creation-of-a-side-chain/index.md b/docs/quick-start/node-operators/creation-of-a-side-chain/index.md index d9505ebf..5c95f39b 100644 --- a/docs/quick-start/node-operators/creation-of-a-side-chain/index.md +++ b/docs/quick-start/node-operators/creation-of-a-side-chain/index.md @@ -3,6 +3,12 @@ sidebar_position: 4 title: Creation of a Side Chain description: How to create a side chain ? --- + +**Description**: +Detailed guidelines and API documentation for creating and managing side chains in the aelf blockchain ecosystem. + +**Purpose**: To provide developers with step-by-step instructions and code examples for proposing, approving, and deploying side chains, enhancing scalability and customization within the aelf network. + # Creation of a Side Chain Side chains can be created in the aelf ecosystem to enable scalability. This section introduces the process in detail. diff --git a/docs/quick-start/node-operators/operations/index.md b/docs/quick-start/node-operators/operations/index.md index fdc38e8f..1d955fcc 100644 --- a/docs/quick-start/node-operators/operations/index.md +++ b/docs/quick-start/node-operators/operations/index.md @@ -6,6 +6,10 @@ title: Operations # Operations +**Description**: Guidelines for setting up nodes and participating in the Block Producer (BP) election process in the aelf blockchain ecosystem. + +**Purpose**: To provide step-by-step instructions for users to become Block Producers, participate in BP elections, and understand the voting and election outcomes within the aelf network. + ## Steps to Become a BP 1. Set up nodes. diff --git a/docs/quick-start/node-operators/run-a-mainnet-node/index.md b/docs/quick-start/node-operators/run-a-mainnet-node/index.md index 4fd2a827..224210a8 100644 --- a/docs/quick-start/node-operators/run-a-mainnet-node/index.md +++ b/docs/quick-start/node-operators/run-a-mainnet-node/index.md @@ -2,6 +2,11 @@ sidebar_position: 2 title: Run a Mainnet Node --- + +**Description**: Instructions on how to join the aelf mainnet by setting up and running a node using Docker or binaries, along with necessary configuration and database setup. + +**Purpose**: To guide users through the process of configuring, deploying, and maintaining an aelf mainnet node, ensuring proper setup for node communication and blockchain synchronization. + ## How to Join the Mainnet There are two ways to run an aelf node: using Docker (recommended) or running binaries from GitHub. Before starting, you need to install some tools and frameworks. Command line instructions are provided for most dependencies. For complex needs, see the [environment setup](/tools/smart-contract-templates/development-environment/) section. diff --git a/docs/quick-start/node-operators/run-a-testnet-node/index.md b/docs/quick-start/node-operators/run-a-testnet-node/index.md index 7ddfed3a..708f08a4 100644 --- a/docs/quick-start/node-operators/run-a-testnet-node/index.md +++ b/docs/quick-start/node-operators/run-a-testnet-node/index.md @@ -3,6 +3,11 @@ sidebar_position: 1 title: Run a Testnet Node description: How to join Testnet --- + +**Description**: Instructions for setting up and running an aelf testnet node using Docker or binaries, including database setup and configuration. + +**Purpose**: To provide detailed guidance on configuring, deploying, and maintaining an aelf testnet node, facilitating testing and development of decentralized applications. + # How to Join the Testnet You can run an aelf node using Docker (recommended) or GitHub binaries. diff --git a/docs/quick-start/node-operators/running-a-side-chain/index.md b/docs/quick-start/node-operators/running-a-side-chain/index.md index 37bfec0d..25cecd7c 100644 --- a/docs/quick-start/node-operators/running-a-side-chain/index.md +++ b/docs/quick-start/node-operators/running-a-side-chain/index.md @@ -4,6 +4,10 @@ title: Run a Side Chain description: Operational details. --- +**Description**: A tutorial on how to configure and run a side chain node in the aelf blockchain ecosystem after its creation has been approved. + +**Purpose**: To guide developers through the setup and launch process of a side chain node, ensuring correct configuration and successful integration with the main chain. + # Running a Side Chain This tutorial explains how to run a side chain node after it has been approved by the producers and released by the creator. After creating the side chain, producers need to run a side chain node. diff --git a/docs/quick-start/node-operators/simulation-in-local-environment/index.md b/docs/quick-start/node-operators/simulation-in-local-environment/index.md index cfbfa85f..82604cbd 100644 --- a/docs/quick-start/node-operators/simulation-in-local-environment/index.md +++ b/docs/quick-start/node-operators/simulation-in-local-environment/index.md @@ -3,6 +3,10 @@ sidebar_position: 3 title: Simulation in the Local Environment --- +**Description**: A guide for simulating a block producer (BP) election and running BP nodes in a local environment within the aelf blockchain ecosystem. + +**Purpose**: To instruct developers on how to set up, configure, and manage multiple nodes, participate in BP elections, and perform key operations for local environment simulations. + # Simulation in the Local Environment ## Set up a Full Node