Skip to content

Commit

Permalink
fix: position of description and purpose
Browse files Browse the repository at this point in the history
  • Loading branch information
vasmohi committed Jul 30, 2024
1 parent e4de4d8 commit 2173bbc
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/node-operators/operations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/node-operators/run-a-mainnet-node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/node-operators/run-a-testnet-node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/node-operators/running-a-side-chain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 20 additions & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]":
version "2.1.5"
resolved "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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==
Expand Down

0 comments on commit 2173bbc

Please sign in to comment.