Merge branch 'develop' into fix/quick-start-hello-world

AElfProject · Jul 4, 2024 · 2bc091f · 2bc091f
2 parents 4a431ae + 91ab4b3
commit 2bc091f
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 49 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Build should pass before merging
+
+on:
+  pull_request:
+    branches: [develop]
+
+jobs:
+  build:
+    name: Check build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'npm'
+
+      - run: npm install
+      - name: create env file
+        run: |
+          touch .env
+          echo TYPESENSE_COLLECTION_NAME="test-collection" >> .env
+          echo TYPESENSE_SERVER_HOST="test-host" >> .env
+          echo TYPESENSE_SEARCH_ONLY_APIKEY="test-api-key" >> .env
+      - run: npm run build
diff --git a/config/typesense-theme-config.json b/config/typesense-theme-config.json
diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,9 @@
 slug: /
 sidebar_position: 0
 title: Home
-description: Homepage
+description: Explore aelf's documentation for in-depth guides on its
+  high-performance AI blockchain, scalable infrastructure & tools for building &
+  managing Web3 DApps.
 image: /img/aelficon.png
 hide_table_of_contents: true
 ---
@@ -11,7 +13,7 @@ hide_table_of_contents: true
 
 # 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.
+aelf is a high-performance, cloud-native, layer-1 blockchain with Mainnet nodes in cloud data centers. It supports parallel smart contract execution, microservices, and scalable MainChain and multi-SideChains architecture. The cross-chain design enables fast data interaction, and its hybrid SideChain model reduces costs and boosts network performance.
 
 <section className="row margin-top--xl">
 
@@ -30,10 +32,16 @@ aelf is a high-performance, cloud-native, layer-1 blockchain network with its Ma
 
 <article className="col col--4 margin-bottom--lg">
 
-## ⭐️ References
+## 📚 Understanding aelf
 
-- [Web API](/docs/web-api/) - Interact with the aelf blockchain through the web
-- [Smart Contract API](/docs/smart-contract-api/) - Access smart contract functionalities using API
+- [Core](/learn/core/) - aelf's core architecture
+- [Cross-chain](/learn/cross-chain/) - aelf's cross-chain architecture
+- [Consensus](/learn/consensus/) - Understanding aelf's consensus mechanism
+- [Network](/learn/network/) - Exploring aelf's network architecture
+- [Addresses](/learn/addresses/) - Managing aelf's blockchain addresses
+- [Transactions](/learn/transactions/) - Handling transaction processes
+- [Smart Contract](/learn/smart-contract/) - aelf's smart contract architecture
+- [ACS Introduction](/learn/acs-introduction/) - An introduction to aelf contract system
 
 </article>
 
@@ -65,16 +73,10 @@ aelf is a high-performance, cloud-native, layer-1 blockchain network with its Ma
 
 <article className="col col--4 margin-bottom--lg">
 
-## 📚 Understanding aelf
+## ⭐️ References
 
-- [Core](/learn/core/) - aelf's core architecture
-- [Cross-chain](/learn/cross-chain/) - aelf's cross-chain architecture
-- [Consensus](/learn/consensus/) - Understanding aelf's consensus mechanism
-- [Network](/learn/network/) - Exploring aelf's network architecture
-- [Addresses](/learn/addresses/) - Managing aelf's blockchain addresses
-- [Transactions](/learn/transactions/) - Handling transaction processes
-- [Smart Contract](/learn/smart-contract/) - aelf's smart contract architecture
-- [ACS Introduction](/learn/acs-introduction/) - An introduction to aelf contract system
+- [Web API](/docs/web-api/) - Interact with the aelf blockchain through the web
+- [Smart Contract API](/docs/smart-contract-api/) - Access smart contract functionalities using API
 
 </article>
 
@@ -92,4 +94,4 @@ aelf is a high-performance, cloud-native, layer-1 blockchain network with its Ma
 
 </article>
 
-</section>
+</section>
diff --git a/docs/learn/network/index.md b/docs/learn/network/index.md
@@ -66,19 +66,19 @@ Nodes use a defined network interface protocol for normal operation and data syn
 When a node connects, it exchanges handshake information. This includes chain status, current height, and more.
 
 - **Request**: 
-    ```proto
+    ```cs
     rpc DoHandshake (HandshakeRequest) returns (HandshakeReply) {}
     ```
 - **Handshake Message**:
-    ```proto
+    ```protobuf
     message Handshake {
         HandshakeData handshake_data = 1;
         bytes signature = 2;
         bytes session_id = 3;
     }
     ```
 - **HandshakeData Message**:
-    ```proto
+    ```protobuf
     message HandshakeData {
         int32 chain_id = 1;
         int32 version = 2;
@@ -95,7 +95,7 @@ When a node connects, it exchanges handshake information. This includes chain st
 #### ConfirmHandshake
 Confirms the handshake with the target node.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc ConfirmHandshake (ConfirmHandshakeRequest) returns (VoidReply) {}
     ```
 
@@ -104,28 +104,28 @@ Confirms the handshake with the target node.
 #### BlockBroadcastStream
 Receives block information after packaging.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc BlockBroadcastStream (stream BlockWithTransactions) returns (VoidReply) {}
     ```
 
 #### TransactionBroadcastStream
 Receives forwarded transaction information.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc TransactionBroadcastStream (stream aelf.Transaction) returns (VoidReply) {}
     ```
 
 #### AnnouncementBroadcastStream
 Receives block announcements.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc AnnouncementBroadcastStream (stream BlockAnnouncement) returns (VoidReply) {}
     ```
 
 #### LibAnnouncementBroadcastStream
 Receives last irreversible block (LIB) announcements.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc LibAnnouncementBroadcastStream (stream LibAnnouncement) returns (VoidReply) {}
     ```
 
@@ -134,14 +134,14 @@ Receives last irreversible block (LIB) announcements.
 #### RequestBlock
 Requests a single block.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc RequestBlock (BlockRequest) returns (BlockReply) {}
     ```
 
 #### RequestBlocks
 Requests multiple blocks.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc RequestBlocks (BlocksRequest) returns (BlockList) {}
     ```
 
@@ -150,13 +150,13 @@ Requests multiple blocks.
 #### Ping
 Verifies network availability.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc Ping (PingRequest) returns (PongReply) {}
     ```
 
 #### CheckHealth
 Performs health checks on peers.
 - **Request**:
-    ```proto
+    ```protobuf
     rpc CheckHealth (HealthCheckRequest) returns (HealthCheckReply) {}
     ```
diff --git a/docs/resources/whitepaper/index.md b/docs/resources/whitepaper/index.md
@@ -8,8 +8,8 @@ description: aelf Whitepapers
 
 ## Infrastructure
 
-To learn more about aelf infrastructure, please refer to [aelf Whitepaper](https://aelf.com/gridcn/aelf_whitepaper_v1.7_en.pdf).
+To learn more about aelf infrastructure, please refer to [aelf Whitepaper](pathname:///pdf/aelf_whitepaper_v1.7_en.pdf).
 
 ## Governance
 
-To learn more about aelf governance, please refer to [aelf Economic and Governance Whitepaper](https://aelf.com/gridcn/aelf_Economic_and_Governance_Whitepaper_v1.2_en.pdf).
+To learn more about aelf governance, please refer to [aelf Economic and Governance Whitepaper](pathname:///pdf/aelf_Economic_and_Governance_Whitepaper_v1.2_en.pdf).
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -12,7 +12,7 @@ const config: Config = {
   trailingSlash: true,
 
   // Set the production url of your site here
-  url: "https://docs.aelf.dev",
+  url: "https://docs.aelf.com",
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: "/",

diff --git a/sidebars.ts b/sidebars.ts
@@ -40,10 +40,6 @@ const sidebars: SidebarsConfig = {
             },
           ],
         },
-        {
-          type: "doc",
-          id: "quick-start/develop-your-first-aelf-smart-contract/index",
-        },
         {
           type: "doc",
           id: "quick-start/explore-running-aelf-side-chain/index",

diff --git a/static/pdf/aelf_Economic_and_Governance_Whitepaper_v1.2_en.pdf b/static/pdf/aelf_Economic_and_Governance_Whitepaper_v1.2_en.pdf
diff --git a/static/pdf/aelf_whitepaper_v1.7_en.pdf b/static/pdf/aelf_whitepaper_v1.7_en.pdf