Skip to content

Commit

Permalink
docs: add homepage content
Browse files Browse the repository at this point in the history
  • Loading branch information
yongenaelf committed Jun 20, 2024
1 parent 76bd25c commit 4647eca
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,58 @@ image: /img/aelficon.png
---

# aelf Documentation

aelf is a high-performance, cloud-native, layer-1 blockchain network with its Mainnet nodes running on different cloud-computing data centers. It provides a high-speed running environment for smart contracts and enables the execution of contracts in parallel and smart contract microservitization running on server clusters. Its MainChain and multi-SideChains architecture supports efficient indexing within the network and guarantees almost unlimited scalability. The built-in cross-chain design facilitates ultra-fast interaction of data. The innovative hybrid of shared SideChain and exclusive SideChain greatly lowers the cost for developers and users and further enhances the overall network performance.

## Quick Start

- Intro to aelf Development
- Develop your first aelf Smart Contract
- Become a Node Operator
- Start and run a node on aelf locally or on cloud
- Run a Side Chain
- Explore running aelf's side chain

## Understanding aelf

- Core - aelf's core architecture
- Cross-chain - aelf's cross-chain architecture
- Consensus - Understanding aelf's consensus mechanism
- Network - Exploring aelf's network architecture
- Addresses - Managing aelf's blockchain addresses
- Transactions - Handling transaction processes
- Smart Contract - aelf's smart contract architecture
- ACS Introduction - An introduction to aelf contract system

## Tutorials

- Smart Contract Development
- Operate a Node
- Run a Testnet Node
- Run a Mainnet Node
- Run a Side Chain
- Run aelf on Cloud

## Tools

- Chain SDK - Develop blockchain specific applications using ChainSDK
- aelf-deploy - Deploy your smart contract using this CLI
- aelf CLI - Execute blockchain operations via CLI
- Smart Contract Templates - Templates to quickly build your smart contract
- Faucet - Test your dApp with aelf test tokens
- Design - Explore aelf design library

## References

- Web API - Interact with the aelf blockchain through the web
- Smart Contract API - Access smart contract functionalities using API

## Resources

- Integration Guide - Learn how to integrate with other tools and DApps
- Wallet and Block Explorer - Manage your assets and explore aelf's blockchain data
- AetherLink - Transfer tamper-proof data from off-chain to on-chain
- Browser Extension - Explore Portkey wallet and other extensions
- DevOps - Tools to build and deploy efficiently
- [aelf Whitepaper](./getting%20started/overview.md#whitepapers) - Read aelf's whitepaper
- Protobuf Extension - An open-source gRPC

0 comments on commit 4647eca

Please sign in to comment.