diff --git a/docs/docs/smart-contract-api/association-contract/index.md b/docs/docs/smart-contract-api/association-contract/index.md index ee895cf..0cd85b9 100644 --- a/docs/docs/smart-contract-api/association-contract/index.md +++ b/docs/docs/smart-contract-api/association-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: Association Contract +description: Association contract handles transactions. --- diff --git a/docs/docs/smart-contract-api/configuration-contract/index.md b/docs/docs/smart-contract-api/configuration-contract/index.md index 766c485..a74a2f3 100644 --- a/docs/docs/smart-contract-api/configuration-contract/index.md +++ b/docs/docs/smart-contract-api/configuration-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 15 title: Configuration Contract +description: Manage the configuration on the blockchain. --- # Configuration Contract diff --git a/docs/docs/smart-contract-api/consensus-contract/index.md b/docs/docs/smart-contract-api/consensus-contract/index.md index b865e1b..1abc6dc 100644 --- a/docs/docs/smart-contract-api/consensus-contract/index.md +++ b/docs/docs/smart-contract-api/consensus-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 4 title: Consensus Contract +description: Manages block producers and data synchronization --- # Consensus Contract diff --git a/docs/docs/smart-contract-api/cross-chain-contract/index.md b/docs/docs/smart-contract-api/cross-chain-contract/index.md index c9b9770..f3939d6 100644 --- a/docs/docs/smart-contract-api/cross-chain-contract/index.md +++ b/docs/docs/smart-contract-api/cross-chain-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 9 title: Cross Chain Contract + --- diff --git a/docs/docs/smart-contract-api/economic-contract/index.md b/docs/docs/smart-contract-api/economic-contract/index.md index b93e68a..bb5b2da 100644 --- a/docs/docs/smart-contract-api/economic-contract/index.md +++ b/docs/docs/smart-contract-api/economic-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 13 title: Economic Contract +description: Establishes aelf's economic system. --- # Economic Contract diff --git a/docs/docs/smart-contract-api/election-contract/index.md b/docs/docs/smart-contract-api/election-contract/index.md index 78a1991..32cbca6 100644 --- a/docs/docs/smart-contract-api/election-contract/index.md +++ b/docs/docs/smart-contract-api/election-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 5 title: Election Contract +description: Election Contract used for voting for Block Producers. --- # Election Contract diff --git a/docs/docs/smart-contract-api/genesis-contract/index.md b/docs/docs/smart-contract-api/genesis-contract/index.md index e46171b..b06c752 100644 --- a/docs/docs/smart-contract-api/genesis-contract/index.md +++ b/docs/docs/smart-contract-api/genesis-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 6 title: Genesis Contract +description: Manage and Update the deployment of contracts. --- # Genesis Contract diff --git a/docs/docs/smart-contract-api/multi-token-contract/index.md b/docs/docs/smart-contract-api/multi-token-contract/index.md index 1e82cf6..ca79daa 100644 --- a/docs/docs/smart-contract-api/multi-token-contract/index.md +++ b/docs/docs/smart-contract-api/multi-token-contract/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 title: Multi Token Contract +description: Manage the user's account and transaction fees. + --- # MultiToken Contract diff --git a/docs/docs/smart-contract-api/parliament-contract/index.md b/docs/docs/smart-contract-api/parliament-contract/index.md index 68864dd..4be1d1b 100644 --- a/docs/docs/smart-contract-api/parliament-contract/index.md +++ b/docs/docs/smart-contract-api/parliament-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 3 title: Parliament Contract +description: Production nodes govern with a two-thirds majority. --- # Parliament Contract diff --git a/docs/docs/smart-contract-api/profit-contract/index.md b/docs/docs/smart-contract-api/profit-contract/index.md index 056bc85..1b8b72f 100644 --- a/docs/docs/smart-contract-api/profit-contract/index.md +++ b/docs/docs/smart-contract-api/profit-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 8 title: Profit Contract +description: Helps in creating a scheme to share bonuses. --- # Profit Contract diff --git a/docs/docs/smart-contract-api/referendum-contract/index.md b/docs/docs/smart-contract-api/referendum-contract/index.md index 3702c58..f943c8c 100644 --- a/docs/docs/smart-contract-api/referendum-contract/index.md +++ b/docs/docs/smart-contract-api/referendum-contract/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 title: Referendum Contract +description: Allows user voting on critical governance decisions. + --- # Referendum diff --git a/docs/docs/smart-contract-api/token-convert-contract/index.md b/docs/docs/smart-contract-api/token-convert-contract/index.md index 4de9d1e..36fb926 100644 --- a/docs/docs/smart-contract-api/token-convert-contract/index.md +++ b/docs/docs/smart-contract-api/token-convert-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 14 title: Token Converter Contract +description: Contract connects the base token with other tokens. --- # Token Converter Contract diff --git a/docs/docs/smart-contract-api/token-holder-contract/index.md b/docs/docs/smart-contract-api/token-holder-contract/index.md index 558a00a..c0e338e 100644 --- a/docs/docs/smart-contract-api/token-holder-contract/index.md +++ b/docs/docs/smart-contract-api/token-holder-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 12 title: Token Holder Contract +description: Builds a bonus model for distributing bonuses to holders. --- # TokenHolder Contract diff --git a/docs/docs/smart-contract-api/treasury-contract/index.md b/docs/docs/smart-contract-api/treasury-contract/index.md index 5ecd87e..246484a 100644 --- a/docs/docs/smart-contract-api/treasury-contract/index.md +++ b/docs/docs/smart-contract-api/treasury-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 10 title: Treasury Contract +description: Used for distributing bonuses to voters and candidates. --- # Treasury Contract diff --git a/docs/docs/smart-contract-api/vote-contract/index.md b/docs/docs/smart-contract-api/vote-contract/index.md index 605b965..934db39 100644 --- a/docs/docs/smart-contract-api/vote-contract/index.md +++ b/docs/docs/smart-contract-api/vote-contract/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 11 title: Vote Contract +description: Vote contract is an abstract layer for voting. --- # Vote Contract diff --git a/docs/learn/addresses/index.md b/docs/learn/addresses/index.md index a31129c..e37bd0f 100644 --- a/docs/learn/addresses/index.md +++ b/docs/learn/addresses/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 5 title: Addresses -description: Addresses +description: This guide explains how addresses work in aelf. image: /img/Logo.aelf.svg --- # Address diff --git a/docs/learn/aelf-blockchain-boot-sequence/index.md b/docs/learn/aelf-blockchain-boot-sequence/index.md index 749d761..2f62a88 100644 --- a/docs/learn/aelf-blockchain-boot-sequence/index.md +++ b/docs/learn/aelf-blockchain-boot-sequence/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 9 title: aelf Blockchain Boot Sequence -description: aelf Blockchain Boot Sequence +description: This guide covers aelf's node startup process. image: /img/Logo.aelf.svg --- diff --git a/docs/learn/consensus/index.md b/docs/learn/consensus/index.md index 0ab8cc4..a61f70f 100644 --- a/docs/learn/consensus/index.md +++ b/docs/learn/consensus/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 3 title: Consensus +description: This guide explains the aelf consensus mechanism. --- # Consensus diff --git a/docs/learn/core/index.md b/docs/learn/core/index.md index 6a30e85..7b75419 100644 --- a/docs/learn/core/index.md +++ b/docs/learn/core/index.md @@ -1,5 +1,5 @@ --- sidebar_position: 1 title: Core -description: aelf Core +description: Overview of aelf, its architecture, and key features. --- \ No newline at end of file diff --git a/docs/learn/core/introduction/index.md b/docs/learn/core/introduction/index.md index fdcd72f..ecaacc7 100644 --- a/docs/learn/core/introduction/index.md +++ b/docs/learn/core/introduction/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: Core Introduction +description: Overview of aelf, its architecture, and key features. --- # Application Pattern diff --git a/docs/learn/network/index.md b/docs/learn/network/index.md index 970ae07..3ae876d 100644 --- a/docs/learn/network/index.md +++ b/docs/learn/network/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 4 title: Network -description: Network +description: This guide explains the aelf's network layer. image: /img/Logo.aelf.svg --- diff --git a/docs/learn/transactions/index.md b/docs/learn/transactions/index.md index e28f845..06b3f0b 100644 --- a/docs/learn/transactions/index.md +++ b/docs/learn/transactions/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 6 title: Transactions -description: Transactions +description: This guide explains how transactions modify the state. image: /img/Logo.aelf.svg --- diff --git a/docs/quick-start/become-a-node-operator/index.md b/docs/quick-start/become-a-node-operator/index.md index 4ed090f..48fa3a6 100644 --- a/docs/quick-start/become-a-node-operator/index.md +++ b/docs/quick-start/become-a-node-operator/index.md @@ -3,6 +3,6 @@ sidebar_position: 3 title: Become a Node Operator --- -# Introduction +## Introduction To become a BP (Block Producer), you must run a full node and participate in the election. The total number of BPs in the aelf network is 2N+1, starting at 8 in 2022 and increasing by 1 each year. If your node ranks in the top 2N+1 in the election, you can participate in block production and aelf governance. This tutorial will guide you on how to become a BP. \ No newline at end of file diff --git a/docs/quick-start/become-a-node-operator/operations/index.md b/docs/quick-start/become-a-node-operator/operations/index.md index 17810d3..7d667bb 100644 --- a/docs/quick-start/become-a-node-operator/operations/index.md +++ b/docs/quick-start/become-a-node-operator/operations/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: Operations + --- # Operations diff --git a/docs/quick-start/develop-your-first-aelf-smart-contract/index.md b/docs/quick-start/develop-your-first-aelf-smart-contract/index.md index eac8d81..7c76092 100644 --- a/docs/quick-start/develop-your-first-aelf-smart-contract/index.md +++ b/docs/quick-start/develop-your-first-aelf-smart-contract/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 4 title: Smart Contract Developing Demos -description: Smart Contract Developing Demos +description: This document provides you Smart Contract examples image: /img/Logo.aelf.svg --- diff --git a/docs/quick-start/explore-running-aelf-side-chain/index.md b/docs/quick-start/explore-running-aelf-side-chain/index.md index 05207b9..9324cf4 100644 --- a/docs/quick-start/explore-running-aelf-side-chain/index.md +++ b/docs/quick-start/explore-running-aelf-side-chain/index.md @@ -1,3 +1,10 @@ +--- +sidebar_position: 4 +title: Requesting the Creation of a Side Chain +description: How to create a side chain ? +--- + + # Requesting the 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/intro-to-aelf-development/index.md b/docs/quick-start/intro-to-aelf-development/index.md index 11fc62a..32a17e2 100644 --- a/docs/quick-start/intro-to-aelf-development/index.md +++ b/docs/quick-start/intro-to-aelf-development/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: Overview +description: Guides and APIs for aelf DApp developers. --- # Developer Documentation Overview @@ -9,7 +10,7 @@ This document provides guidelines, documents, and API references for developers ## Introduction to aelf -aelf is a comprehensive solution for Web3 DApps, offering a cloud-native, high-performance blockchain system. It supports DeFi and Metaverse applications, providing a secure, fast, and cost-efficient environment. +aelf is a comprehensive solution for Web3 DApps, offering a cloud-native, high-performance blockchain system. It supports DeFi and Metaverse applications, providing a secure, fast, and cost-efficient environment. ## Key Features diff --git a/docs/quick-start/run-a-side-chain/index.md b/docs/quick-start/run-a-side-chain/index.md index 8c20565..d77f179 100644 --- a/docs/quick-start/run-a-side-chain/index.md +++ b/docs/quick-start/run-a-side-chain/index.md @@ -1,3 +1,8 @@ +--- +title: Running a Side Chain +description: How to run a side chain after its released ? +--- + # Running a Side Chain (After its Release) 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/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md b/docs/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md index 09c1df6..67124d0 100644 --- a/docs/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md +++ b/docs/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md @@ -1,3 +1,8 @@ +--- +title: Getting Started with Google Cloud +description: How to run aelf node on Google Cloud Platform (GCP) ? +--- + # Getting Started with Google Cloud This guide will walk you through the steps required to run an aelf node on Google Cloud Platform (GCP). diff --git a/docs/tools/aelf-deploy/index.md b/docs/tools/aelf-deploy/index.md index a3b3f96..28cf679 100644 --- a/docs/tools/aelf-deploy/index.md +++ b/docs/tools/aelf-deploy/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 title: aelf Deploy Tool +description: aelf-deploy simplifies contract updates. --- # aelf Deploy Tool diff --git a/docs/tools/design/index.md b/docs/tools/design/index.md index cf4275f..8c246da 100644 --- a/docs/tools/design/index.md +++ b/docs/tools/design/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 6 title: aelf Design +description: UI component library based on Antd. ---
diff --git a/docs/tools/faucet/index.md b/docs/tools/faucet/index.md index d1ef95b..10e0432 100644 --- a/docs/tools/faucet/index.md +++ b/docs/tools/faucet/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 5 title: aelf Testnet Faucet +description: Get your free test aelf tokens. --- import Tabs from '@theme/Tabs';