From 2173bbc11f1c8a7a77daf36606fd896fe3bc4c15 Mon Sep 17 00:00:00 2001 From: vasmohi Date: Tue, 30 Jul 2024 14:15:38 +0530 Subject: [PATCH] fix: position of description and purpose --- .../creation-of-a-side-chain/index.md | 3 +-- .../node-operators/operations/index.md | 4 ++-- .../run-a-mainnet-node/index.md | 4 ++-- .../run-a-testnet-node/index.md | 4 ++-- .../running-a-side-chain/index.md | 4 ++-- .../simulation-in-local-environment/index.md | 4 ++-- package-lock.json | 8 +++---- yarn.lock | 21 ++++++++++++++++++- 8 files changed, 35 insertions(+), 17 deletions(-) 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 5c95f39b..042ae2fa 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,14 +3,13 @@ sidebar_position: 4 title: Creation of a Side Chain description: How to create a side chain ? --- +# Creation of 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. ## Side Chain Creation API diff --git a/docs/quick-start/node-operators/operations/index.md b/docs/quick-start/node-operators/operations/index.md index 1d955fcc..9b3661f9 100644 --- a/docs/quick-start/node-operators/operations/index.md +++ b/docs/quick-start/node-operators/operations/index.md @@ -4,12 +4,12 @@ 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. +# Operations + ## 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 224210a8..41016a30 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 @@ -3,12 +3,12 @@ sidebar_position: 2 title: Run a Mainnet Node --- +## How to Join the Mainnet + **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. ### Steps to Set Up a Node 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 708f08a4..cda51a55 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 @@ -4,12 +4,12 @@ title: Run a Testnet Node description: How to join Testnet --- +# How to Join the 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. Before starting, install the necessary tools and frameworks. Detailed instructions are in the [environment setup](/tools/smart-contract-templates/development-environment/) section. 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 25cecd7c..3cbabea0 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,12 +4,12 @@ title: Run a Side Chain description: Operational details. --- +# Running a Side Chain + **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. ## Prerequisites 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 82604cbd..8191e7d6 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,12 +3,12 @@ sidebar_position: 3 title: Simulation in the Local Environment --- +# 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 To simulate BP nodes in a local environment, you need to set up at least three nodes, as a single node cannot become a BP. BP elections occur every 7 days, but for this tutorial, we'll change the term to 120 seconds. Follow the steps below: diff --git a/package-lock.json b/package-lock.json index 54f0e1a4..b67d9d7c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,7 +11,7 @@ "@docusaurus/core": "3.4.0", "@docusaurus/preset-classic": "3.4.0", "@mdx-js/react": "^3.0.0", - "chaingpt-component": "^0.1.5", + "chaingpt-component": "^0.1.9", "clsx": "^2.0.0", "docusaurus-theme-search-typesense": "^0.20.0-0", "dotenv": "^16.4.5", @@ -4447,9 +4447,9 @@ } }, "node_modules/chaingpt-component": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/chaingpt-component/-/chaingpt-component-0.1.5.tgz", - "integrity": "sha512-2YgHWu+BX4cyyNbHzTxfZK50B1160pfWgxu/WsHNBvTc61ABneSBwexU5YlkgdEvKozDjRcqWzKutwNwYo2sGg==", + "version": "0.1.9", + "resolved": "https://registry.npmjs.org/chaingpt-component/-/chaingpt-component-0.1.9.tgz", + "integrity": "sha512-qsH8S8zzsB7YJX3EDHnkhICX8hhQmFBQDfa+SZnX8gjb7YpycGQA3sr5e2FnqmVu/AV7s6tB2NuEUx9HRu6zFw==", "dependencies": { "@microsoft/fetch-event-source": "^2.0.1", "react": "^18.3.1", diff --git a/yarn.lock b/yarn.lock index 3209e83f..524dec11 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1794,6 +1794,11 @@ dependencies: "@types/mdx" "^2.0.0" +"@microsoft/fetch-event-source@^2.0.1": + version "2.0.1" + resolved "https://registry.npmjs.org/@microsoft/fetch-event-source/-/fetch-event-source-2.0.1.tgz" + integrity sha512-W6CLUJ2eBMw3Rec70qrsEW0jOm/3twwJv21mrmj2yORiaVmVYGS4sSS5yUwvQc1ZlDLYGPnClVWmUUMagKNsfA== + "@nodelib/fs.scandir@2.1.5": version "2.1.5" resolved "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz" @@ -2930,6 +2935,15 @@ ccount@^2.0.0: resolved "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz" integrity sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg== +chaingpt-component@^0.1.9: + version "0.1.9" + resolved "https://registry.npmjs.org/chaingpt-component/-/chaingpt-component-0.1.9.tgz" + integrity sha512-qsH8S8zzsB7YJX3EDHnkhICX8hhQmFBQDfa+SZnX8gjb7YpycGQA3sr5e2FnqmVu/AV7s6tB2NuEUx9HRu6zFw== + dependencies: + "@microsoft/fetch-event-source" "^2.0.1" + react "^18.3.1" + react-dom "^18.3.1" + chalk@^2.4.2: version "2.4.2" resolved "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz" @@ -4265,6 +4279,11 @@ fs.realpath@^1.0.0: resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz" integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== +fsevents@~2.3.2: + version "2.3.3" + resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + function-bind@^1.1.2: version "1.1.2" resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz" @@ -7090,7 +7109,7 @@ react-dev-utils@^12.0.1: strip-ansi "^6.0.1" text-table "^0.2.0" -react-dom@*, "react-dom@^16.6.0 || ^17.0.0 || ^18.0.0", react-dom@^18.0.0, "react-dom@>= 16.8.0 < 19.0.0": +react-dom@*, "react-dom@^16.6.0 || ^17.0.0 || ^18.0.0", react-dom@^18.0.0, react-dom@^18.3.1, "react-dom@>= 16.8.0 < 19.0.0": version "18.3.1" resolved "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz" integrity sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==