-
Notifications
You must be signed in to change notification settings - Fork 257
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved intro and keep readme like normal readme.
- Loading branch information
Showing
3 changed files
with
48 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,3 @@ | ||
| Welcome to AElf's official documentation. This Gitbook is where we centralize our guides, documents and api references. Wether you're a dApp developer looking to build some awesome apps on top of AElf or simply just interested in seeing what a running node looks like, this place is for you! | ||
| # AElf documentation | ||
|
|
||
| As of today the documentation is correct but still a work in progress so we invite you to frequently visit and discover any new content. | ||
|
|
||
| #### A bit more about AElf | ||
|
|
||
| AElf's main objective is to permit scalability and extensibility through a multi-layer branching structure formed by a main chain and multiple levels of side-chains (a tree like structure). Each side-chain will be designed for one business use case. | ||
|
|
||
| AElf also aims to make it as easy as possible to extend/customize the system by providing easy to use tools and frameworks in order to customize the chains and write smart contracts. AElf will support various languages that will let developers choose the one they are the most comfortable with. | ||
|
|
||
| AElf will improve overall blockchain performance by executing transactions in parallel and isolating smart contracts in their own side-chains in order to segregate the systems resources. | ||
|
|
||
| ## This Gitbook | ||
|
|
||
| This Gitbook contains various different types of documentation and depending on what you will use AElf for, you should navigate to different sections. Here are a few links you can follow to get you started: | ||
| - [**how to start a node**](Introduction/quickstart.md) | ||
| - [**how to develop dApp**](tutorials/dapp/main.md) | ||
|
|
||
| #### Guides and tutorials | ||
|
|
||
| - [**tutorials**](tutorials/main.md) - groups end-to-end guides and tutorials about various topics. | ||
| - [**getting started**](Introduction/main.md) - if you've never run an AElf node, we recommend you start with this section contains. | ||
|
|
||
| #### AElf concepts | ||
|
|
||
| - [**protocol**](Protocol/main.md) - some articles about blockchain related concepts and how they are used and implemented in AElf. | ||
| - [**smart contract**](Contract/main.md) - a more advanced section with more in-depth explanations of AElf smart contracts. | ||
| - [**cross chain**](crosschain/main.md) - information about how AElf implements side chains. | ||
| - [**public chain ecosystem**](publicchain/main.md) - information related to AElf's public blockchain and ecosystem. | ||
| - [**architecture**](Architecture/main.md) - this section is for **advanced** users, it explains the architectural concepts behind the nodes design. | ||
|
|
||
| #### References | ||
|
|
||
| - [**command line**](cli/methods.md) - a reference for the available commands on AElf's CLI. | ||
| - [**web api**](Web/main.md) - a reference for the available methods on AElf's web api. | ||
| - [**js sdk**](SDK/javascript/js-sdk.md) - a reference for the available APIs in the js SDK. | ||
|
|
||
| Finally we have a more complete API references for the Command Line Interface, the js-sdk and the nodes RPC interface. | ||
|
|
||
| ## Some resources | ||
|
|
||
| You can find the original whitepaper [here](https://aelf.io/gridcn/aelf_whitepaper_EN.pdf?v=1.6). It will give you a more thorough explanation on the concepts that drive AElf and its development. | ||
|
|
||
| Of course, there's the official GitHub [here](https://github.com/AElfProject/AElf) and the js-sdk repo [here](https://github.com/AElfProject/aelf-sdk.js). | ||
| You will find here the markdown for AElf's documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| Welcome to AElf's official documentation. This Gitbook is where we centralize our guides, documents and api references. Wether you're a dApp developer looking to build some awesome apps on top of AElf or simply just interested in seeing what a running node looks like, this place is for you! | ||
|
|
||
| As of today the documentation is correct but still a work in progress so we invite you to frequently visit and discover any new content. | ||
|
|
||
| #### A bit more about AElf | ||
|
|
||
| AElf's main objective is to permit scalability and extensibility through a multi-layer branching structure formed by a main chain and multiple levels of side-chains (a tree like structure). Each side-chain will be designed for one business use case. | ||
|
|
||
| AElf also aims to make it as easy as possible to extend/customize the system by providing easy to use tools and frameworks in order to customize the chains and write smart contracts. AElf will support various languages that will let developers choose the one they are the most comfortable with. | ||
|
|
||
| AElf will improve overall blockchain performance by executing transactions in parallel and isolating smart contracts in their own side-chains in order to segregate the systems resources. | ||
|
|
||
| ## This Gitbook | ||
|
|
||
| This Gitbook contains various different types of documentation and depending on what you will use AElf for, you should navigate to different sections. Here are a few links you can follow to get you started: | ||
| - [**how to start a node**](Introduction/quickstart.md) | ||
| - [**how to develop dApp**](tutorials/dapp/main.md) | ||
|
|
||
| #### Guides and tutorials | ||
|
|
||
| - [**tutorials**](tutorials/main.md) - groups end-to-end guides and tutorials about various topics. | ||
| - [**getting started**](Introduction/main.md) - if you've never run an AElf node, we recommend you start with this section contains. | ||
|
|
||
| #### AElf concepts | ||
|
|
||
| - [**protocol**](Protocol/main.md) - some articles about blockchain related concepts and how they are used and implemented in AElf. | ||
| - [**smart contract**](Contract/main.md) - a more advanced section with more in-depth explanations of AElf smart contracts. | ||
| - [**cross chain**](crosschain/main.md) - information about how AElf implements side chains. | ||
| - [**public chain ecosystem**](publicchain/main.md) - information related to AElf's public blockchain and ecosystem. | ||
| - [**architecture**](Architecture/main.md) - this section is for **advanced** users, it explains the architectural concepts behind the nodes design. | ||
|
|
||
| #### References | ||
|
|
||
| - [**command line**](cli/methods.md) - a reference for the available commands on AElf's CLI. | ||
| - [**web api**](Web/main.md) - a reference for the available methods on AElf's web api. | ||
| - [**js sdk**](SDK/javascript/js-sdk.md) - a reference for the available APIs in the js SDK. | ||
|
|
||
| Finally we have a more complete API references for the Command Line Interface, the js-sdk and the nodes RPC interface. | ||
|
|
||
| ## Some resources | ||
|
|
||
| You can find the original whitepaper [here](https://aelf.io/gridcn/aelf_whitepaper_EN.pdf?v=1.6). It will give you a more thorough explanation on the concepts that drive AElf and its development. | ||
|
|
||
| Of course, there's the official GitHub [here](https://github.com/AElfProject/AElf) and the js-sdk repo [here](https://github.com/AElfProject/aelf-sdk.js). |