Merge pull request #42 from airchains-network/development

Updated introduction page

Author: SlayeR6889

docs/api-reference/index.md

@@ -9,6 +9,6 @@ sidebar_position: 1
 
 # API Reference
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />

docs/develop/contribute.md

@@ -9,6 +9,6 @@ sidebar_position: 5
 
 # Contribute
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />

docs/develop/exercise/hands-on-fhevm/index.md

@@ -1,21 +1,21 @@
 ---
-id: hands-on-fhevm
-title: Hands-on FHEVM
+id: index
+title: Hands-on fhEVM
 description: --
-slug: /develop/exercise/hands-on-fhevm/hands-on-fhevm
+slug: /develop/exercise/hands-on-fhevm
 hide_table_of_contents: false
 sidebar_position: 1
 ---
 
-# Hands-on FHEVM
+# Hands-on fhEVM
 
-**fhEVM** enables **privacy-preserving smart contracts** on **EVM-compatible blockchains**. This hands-on guide will walk you through **understanding, setting up, and working with fhEVM** to develop encrypted smart contracts.
+This hands-on guide will walk you through **understanding, setting up, and working with fhEVM** to develop encrypted smart contracts and test them on fhEVM network.
 
 ### What You’ll Learn
 
-- Basics of **fhEVM and its architecture**.
-- Setting up a **local fhEVM development environment**.
-- Writing, compiling, and deploying **FHE-enabled Solidity contracts**.
+- Basics of fhEVM and its architecture.
+- Setting up a local fhEVM development environment.
+- Writing, compiling, and deploying FHE-enabled Solidity contracts.
 - Testing encrypted contract interactions.
 
 ---
@@ -92,19 +92,19 @@ For more detailed insights, you can refer to the **[official documentation by Za
 
 ### **What's Next?**
 
-Now that you understand the **fhEVM architecture**, let's set up an **fhEVM network**.  
+Now that you understand the **fhEVM architecture**, let's set up an **fhEVM network**.
 ➡ Move on to **[Network Setup](./setting-up-network.md)** to learn how to proceed.
 
 
-<!-- 
+<!--
 ## **3. Setting Up Your Development Environment**
 
 Before writing encrypted contracts, install the necessary tools.
 
 ### **Prerequisites**
 
-✔ **Go** (`v1.23.x` or later)  
-✔ **Docker** (`v26.x.x` or later)  
+✔ **Go** (`v1.23.x` or later)
+✔ **Docker** (`v26.x.x` or later)
 ✔ **Node.js** (`v20.x` or later)
 
 📖 **[Full Setup Guide](./preparation.md)**
@@ -143,11 +143,11 @@ fhEVM supports **Fully Homomorphic Encryption (FHE)** within Solidity contracts.
 
 ### **Key Contract Operations**
 
-✔ **EncryptedERC20**: Secure token minting, transfer, and approvals.  
-✔ **Homomorphic Computation**: Arithmetic on encrypted balances.  
+✔ **EncryptedERC20**: Secure token minting, transfer, and approvals.
+✔ **Homomorphic Computation**: Arithmetic on encrypted balances.
 ✔ **Decryption via Gateway**: Interact with KMS securely.
 
-📖 **[Writing Smart Contracts](./writing-smart-contract.md)**  
+📖 **[Writing Smart Contracts](./writing-smart-contract.md)**
 📖 **[Deploying Smart Contracts](./compiling-and-deploying.md)**
 
 ---
@@ -158,9 +158,9 @@ To validate your contracts, write **JavaScript-based tests** using `ethers.js`.
 
 ### **Example Test Cases**
 
-✔ **Minting Tokens**  
-✔ **Encrypted Transfers**  
-✔ **Encrypted Approvals**  
+✔ **Minting Tokens**
+✔ **Encrypted Transfers**
+✔ **Encrypted Approvals**
 ✔ **Balance Decryption**
 
 📖 **[Writing Test Files](./writing-contract-test-files.md)**
@@ -177,8 +177,8 @@ By completing this hands-on guide, you now understand:
 
 ### **Next Steps**
 
-🔹 Explore **advanced encrypted contract interactions**.  
-🔹 Contribute to **fhEVM projects and research**.  
+🔹 Explore **advanced encrypted contract interactions**.
+🔹 Contribute to **fhEVM projects and research**.
 🔹 Learn more from **[Zama’s Official Documentation](https://docs.zama.ai/fhevm)**.
 
 📖 **[Final Thoughts & Summary](./08-conclusion.md)**

docs/develop/exercise/hands-on-fhevm/prerequisites.md

@@ -1,7 +1,7 @@
 ---
 id: prerequisites
 title: Prerequisites
-description: This guide walks you through configuring your development setup, ensuring seamless interaction with the FHEVM network for encrypted smart contract execution
+description: This guide walks you through configuring your development setup, ensuring seamless interaction with the fhEVM network for encrypted smart contract execution
 slug: /develop/exercise/hands-on-fhevm/prerequisites
 hide_table_of_contents: false
 sidebar_position: 2

docs/develop/exercise/hands-on-fhevm/setting-up-network.md

@@ -1,7 +1,7 @@
 ---
 id: setting-up-network
 title: Setting Up Network
-description: This guide walks you through configuring your development setup, ensuring seamless interaction with the FHEVM network for encrypted smart contract execution
+description: This guide walks you through configuring your development setup, ensuring seamless interaction with the fhEVM network for encrypted smart contract execution
 slug: /develop/exercise/hands-on-fhevm/setting-up-network
 hide_table_of_contents: false
 sidebar_position: 3
@@ -10,7 +10,7 @@ sidebar_position: 3
 # Setting Up Network
 
 :::note Preparation
-Before you start, ensure you have the necessary tools and dependencies installed on your system. 
+Before you start, ensure you have the necessary tools and dependencies installed on your system.
 Follow the steps mentioned in the prerequisites section [here](./prerequisites.md).
 :::
 
@@ -45,7 +45,7 @@ Once Go and Docker are installed, clone the **hands-on-fhevm** repository from G
 
 ---
 
-## Setting Up the FHEVM Network using Docker
+## Setting Up the fhEVM Network using Docker
 
 This section will guide you through setting up your **fhevm network** using Docker.
 
@@ -85,7 +85,7 @@ make stop-full
 
 Your fhevm-network is now ready to use. Proceed to [Compiling and Deploying](./compiling-and-deploying.md) your smart contracts.
 
-<!-- 
+<!--
 
 ## Step 5: Clone the Project Repository and Setup
 
@@ -120,4 +120,4 @@ Once Go and Docker are installed, clone the **hands-on-fhevm** repository from G
 
    ```bash
    npm start
-   ``` -->
+   ``` -->

docs/develop/exercise/hands-on-fhevm/writing-contract-test.md

@@ -1,7 +1,7 @@
 ---
 id: writing-contract-test
-title: Writing Smart Contract Tests
-description: This guide provides instructions on writing tests for Fully Homomorphic Encryption Virtual Machine (fhEVM) smart contracts.
+title: Writing Smart Contract Test
+description: This guide provides instructions on writing test for fhEVM  smart contracts.
 slug: /develop/exercise/hands-on-fhevm/writing-contract-test
 hide_table_of_contents: false
 sidebar_position: 6
@@ -19,18 +19,18 @@ The tutorial uses several key libraries and utilities:
 
 ```javascript
 import { JsonRpcProvider, Wallet, Contract } from "ethers"; // Core ethers.js components
-import { createInstance } from "../utils/create-instance.js"; // FHEVM instance creation
+import { createInstance } from "../utils/create-instance.js"; // fhEVM instance creation
 import { loadABI } from "../utils/load-abi.js"; // ABI loading utility
 import logger from "../utils/logger.js"; // Logging utility
 ```
 
 ### Understanding Key Components
 
-#### FHEVM Instance Creation
+#### fhEVM Instance Creation
 
 The `createInstance` function is crucial for our cryptographic operations:
 
-- Creates an instance of the FHEVM (Fully Homomorphic Encryption Virtual Machine)
+- Creates an instance of the fhEVM (Fully Homomorphic Encryption Virtual Machine)
 - Enables secure operations on encrypted data
 - Is required for privacy-preserving transactions
 
@@ -138,7 +138,7 @@ export async function transferTokens(
       contractAddress
     );
 
-    // Create FHEVM instance for encryption
+    // Create fhEVM instance for encryption
     const fhevmInstance = await createInstance();
 
     // Prepare encrypted input

docs/develop/exercise/hands-on-fhevm/writing-smart-contract.md

@@ -7,9 +7,11 @@ hide_table_of_contents: false
 sidebar_position: 5
 ---
 
-# Writing Smart Contracts for the FHEVM
+# Writing Smart Contracts for the fhEVM
 
-The FHEVM environment enables Fully Homomorphic Encryption (FHE) computations directly on encrypted data within Ethereum-like smart contracts. This means that the contract can store, process, and manipulate data in ciphertext form without ever exposing the underlying cleartext values. As a result, developers can build decentralized applications that protect user privacy on a public blockchain.
+The fhEVM environment enables Fully Homomorphic Encryption (FHE) computations directly on encrypted data within Ethereum-like smart contracts. This means that the contract can store, process, and manipulate data in ciphertext form without ever exposing the underlying cleartext values. As a result, developers can build decentralized applications that protect user privacy on a public blockchain.
+
+This is a simple example of an ERC20 token smart contract. For writing more complex contracts, please refer to the [fhEVM documentation](https://docs.zama.ai/fhevm/0.5-4/guides) for more details.
 
 ---
 
@@ -31,8 +33,8 @@ The contract uses the following dependencies:
 
 ```solidity
 import "./core/lib/TFHE.sol";
-import "@openzeppelin/contracts/access/Ownable2Step.sol";
 import "./core/gateway/GatewayCaller.sol";
+import "@openzeppelin/contracts/access/Ownable2Step.sol";
 ```
 
 ---

docs/develop/exercise/index.md

@@ -9,6 +9,6 @@ sidebar_position: 2
 
 # Exercise
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import Exercise from '@site/src/components/docs/exercise.js';
 
-<UnderProgress />
+<Exercise />

docs/develop/kms.md

@@ -9,6 +9,6 @@ sidebar_position: 3
 
 # Key Management Service
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />

docs/develop/relayers.md

@@ -9,6 +9,6 @@ sidebar_position: 4
 
 # Relayers
 
-import UnderProgress from '@site/src/components/Docs/under-progress.js';
+import UnderProgress from '@site/src/components/docs/under-progress.js';
 
 <UnderProgress />