From 8bfdd13d8b6e327a3e07d396865ae1cd8dd6aa03 Mon Sep 17 00:00:00 2001 From: yongenaelf <132553186+yongenaelf@users.noreply.github.com> Date: Mon, 9 Sep 2024 22:45:10 +0800 Subject: [PATCH] Refactor/reorganise links (#228) * refactor: reorganise links * link to portkey wallet * fix: oracle link * revert --- docs/index.md | 23 ++++-------- docs/tools/aelf-playground/index.md | 2 +- docs/tools/chain-sdk/_category_.json | 6 ++-- docs/tools/faucet/index.md | 6 ++-- .../aetherLink => tools/oracle}/index.md | 4 +-- sidebars.ts | 35 ++++++++++++++++++- 6 files changed, 49 insertions(+), 27 deletions(-) rename docs/{resources/aetherLink => tools/oracle}/index.md (99%) diff --git a/docs/index.md b/docs/index.md index 158fb04a..c70a7133 100644 --- a/docs/index.md +++ b/docs/index.md @@ -58,16 +58,12 @@ aelf is a high-performance, cloud-native, layer-1 blockchain with Mainnet nodes ## 🛠️ Tools - [Playground](/tools/aelf-playground/) - Play with aelf in your browser -- [Chain SDK](/tools/chain-sdk/) - Develop blockchain specific applications using ChainSDK -- [aelf-deploy](/tools/aelf-deploy/) - Deploy your smart contract using this CLI -- [aelf CLI](/tools/aelf-cli/) - Execute blockchain operations via CLI -- [Smart Contract Templates](/tools/smart-contract-templates/) - Templates to quickly build your smart contract +- [Wallet](https://portkey.finance/) - Integrate your dApp with Portkey wallet - [Faucet](/tools/faucet/) - Test your dApp with aelf test tokens -- [Design](/tools/design/) - Explore aelf design library -- [Contract SDK](/tools/contract-sdk/) - C# SDKs -- [Smart Contract API](/tools/smart-contract-api/) - Access smart contract functionalities using API -- [Web API](/tools/web-api/) - Interact with the aelf blockchain through the web -- [Setup Local Environment](/tools/setup-local-environment/) - Node operator and developer setup guides +- [Oracle](/tools/oracle/) - Transfer tamper-proof data from off-chain to on-chain +- [Indexer](https://www.aefinder.io/) - Query blockchain data from a database +- [aelf SDK](/tools/chain-sdk/) - Develop blockchain specific applications using aelf SDK +- [aelf CLI](/tools/aelf-cli/) - Execute blockchain operations via CLI @@ -76,15 +72,8 @@ aelf is a high-performance, cloud-native, layer-1 blockchain with Mainnet nodes ## 🔖 Resources - [Whitepaper 2.0](/resources/whitepaper-2/) - Featuring AI + Blockchain -- [Whitepaper 1.0](/resources/whitepaper/) - The original aelf Whitepaper - [Tokenomics](/resources/tokenomics/) - Economic and Governance -- [Integration Guide](/resources/integration-guide/) - Learn how to integrate with other tools and DApps -- [Wallet and Block Explorer](/resources/wallet-and-block-explorer/) - Manage your assets and explore aelf's blockchain data -- [AetherLink](/resources/aetherLink/) - Transfer tamper-proof data from off-chain to on-chain -- [Browser Extension](/resources/browser-extension/) - Explore Portkey wallet and other extensions -- [DevOps](/resources/devops/) - Tools to build and deploy efficiently -- [Protobuf Extension](/resources/protobuf-extension/) - An open-source gRPC -- [Contribution Guide](/resources/contribution/) - Contribute to aelf +- [Other](/resources/) - Other resources diff --git a/docs/tools/aelf-playground/index.md b/docs/tools/aelf-playground/index.md index 285306ad..8f840a8f 100644 --- a/docs/tools/aelf-playground/index.md +++ b/docs/tools/aelf-playground/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -title: aelf Playground +title: Playground description: Play with aelf in your browser. --- diff --git a/docs/tools/chain-sdk/_category_.json b/docs/tools/chain-sdk/_category_.json index 625fa282..8cee5133 100644 --- a/docs/tools/chain-sdk/_category_.json +++ b/docs/tools/chain-sdk/_category_.json @@ -1,11 +1,11 @@ { - "position": 2, - "label": "Chain SDK", + "position": 6, + "label": "aelf SDK", "collapsible": true, "collapsed": true, "link": { "type": "generated-index", - "title": "Chain SDK", + "title": "aelf SDK", "slug": "tools/chain-sdk" }, "customProps": { diff --git a/docs/tools/faucet/index.md b/docs/tools/faucet/index.md index 31e5a51e..da24f605 100644 --- a/docs/tools/faucet/index.md +++ b/docs/tools/faucet/index.md @@ -1,7 +1,7 @@ --- -sidebar_position: 6 -title: aelf Testnet Faucet -description: Get your free test aelf tokens. +sidebar_position: 3 +title: Faucet +description: Test your dApp with aelf test tokens --- import Tabs from '@theme/Tabs'; diff --git a/docs/resources/aetherLink/index.md b/docs/tools/oracle/index.md similarity index 99% rename from docs/resources/aetherLink/index.md rename to docs/tools/oracle/index.md index 90cf2218..bcc0a5e7 100644 --- a/docs/resources/aetherLink/index.md +++ b/docs/tools/oracle/index.md @@ -1,6 +1,6 @@ --- -sidebar_position: 6 -title: AetherLink +sidebar_position: 4 +title: Oracle description: Transfer tamper-proof data from off-chain to on-chain --- diff --git a/sidebars.ts b/sidebars.ts index 84bf8231..0a556b94 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -57,7 +57,40 @@ const sidebars: SidebarsConfig = { type: "generated-index", slug: "tools", }, - items: [{ type: "autogenerated", dirName: "tools" }], + items: [ + { type: "doc", id: "tools/aelf-playground/index" }, + { type: "link", label: "Wallet", href: "https://portkey.finance/", description: "Integrate your dApp with Portkey wallet" }, + { type: "doc", id: "tools/faucet/index" }, + { type: "doc", id: "tools/oracle/index" }, + { + type: "link", + label: "Indexer", + href: "https://aefinder.io/", + description: "Query blockchain data from a database", + }, + { + type: "category", + label: "aelf SDK", + link: { type: "generated-index", slug: "tools/chain-sdk" }, + customProps: { + description: "Command-line interface for aelf", + }, + items: [{ type: "autogenerated", dirName: "tools/chain-sdk" }], + }, + { + type: "category", + label: "aelf CLI", + link: { + type: "generated-index", + title: "aelf CLI", + slug: "tools/aelf-cli", + }, + customProps: { + description: "Command-line interface for aelf", + }, + items: [{ type: "autogenerated", dirName: "tools/aelf-cli" }], + }, + ], }, ], resources: [