Adjust docs styling

ChorusOne · Jul 26, 2024 · 7af3802 · 7af3802
1 parent 832bc5a
commit 7af3802
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 35 deletions.
diff --git a/book/build-your-staking-dapp/avalanche/overview.md b/book/build-your-staking-dapp/avalanche/overview.md
@@ -1,23 +1,23 @@
 # Overview
 
-Staking on the Avalanche network (AVAX) involves locking up tokens to support the network's security and operations. In return, stakers earn rewards.
-
 {% hint style="info" %}
 The Avalanche blockchain, renowned for its rapid transaction processing, low fees, and eco-friendly architecture, utilizes a unique consensus protocol known as Avalanche Consensus. This protocol enables a high degree of decentralization and security, allowing validators to participate by staking AVAX, the network's native token.
 {% endhint %}
 
+Staking on the Avalanche network (AVAX) involves locking up tokens to support the network's security and operations. In return, stakers earn rewards.
+
 The **Chorus One SDK** simplifies this process, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+This guide will walk you through the fundamentals of staking on Avalanche using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular Avalanche libraries such as `@avalabs/avalanchejs`. This compatibility ensures that you can seamlessly integrate these methods into your existing Avalanche projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on Avalanche using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on the Avalanche network using the Chorus One SDK, you will first need to initialize the SDK.

diff --git a/book/build-your-staking-dapp/cosmos/overview.md b/book/build-your-staking-dapp/cosmos/overview.md
@@ -8,16 +8,16 @@ The Cosmos network, renowned for its interoperability and modular framework, uti
 
 The **Chorus One SDK** simplifies this process, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+This guide will walk you through the fundamentals of staking on Cosmos using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular Cosmos libraries such as `@cosmjs/cosmwasm`. This compatibility ensures that you can seamlessly integrate these methods into your existing Cosmos projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on Cosmos using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on the Cosmos network using the Chorus One SDK, you will first need to initialize the SDK for Cosmos.

diff --git a/book/build-your-staking-dapp/ethereum/overview.md b/book/build-your-staking-dapp/ethereum/overview.md
@@ -10,18 +10,18 @@ The Ethereum blockchain, renowned for its smart contract functionality and vibra
 
 The **Chorus One SDK** simplifies the staking process on the Ethereum network, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+To enhance efficiency, the SDK leverages [Stakewise V3's](https://docs.stakewise.io/) audited and secure smart contracts. By utilizing a pooling solution, it allows multiple users to combine their stakes, making staking more accessible and beneficial for smaller stakeholders.
+
+This guide will walk you through the fundamentals of staking on Ethereum using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular Ethereum libraries such as `Ethers` and `viem`. This compatibility ensures that you can seamlessly integrate these methods into your existing Ethereum projects.
 
 {% endhint %}
 
-To enhance efficiency, the SDK leverages [Stakewise V3's](https://docs.stakewise.io/) audited and secure smart contracts. By utilizing a pooling solution, it allows multiple users to combine their stakes, making staking more accessible and beneficial for smaller stakeholders.
-
-This guide will walk you through the fundamentals of staking on Ethereum using the Chorus One SDK.
-
 ## Understanding Key Concepts
 
 <details>
@@ -121,9 +121,7 @@ const { tx } = await staker.buildStakeTx({
 })
 ```
 
-{% hint style="warning" %}
-
-**Ensuring Correct Amount Format for Staking**
+### Ensuring Correct Amount Format for Staking
 
 The `amount` parameter must be a string representing the amount of ETH to deposit. For example, `'1'` represents 1 ETH.
 
@@ -140,8 +138,6 @@ console.log(amountToStake) // "0.01"
 
 This ensures the `amountToStake` parameter is in the correct format for the staking transaction function.
 
-{% endhint %}
-
 ---
 
 ## Getting the Validator Address provided by Chorus One

diff --git a/book/build-your-staking-dapp/near/overview.md b/book/build-your-staking-dapp/near/overview.md
@@ -8,16 +8,16 @@ The NEAR blockchain, known for its scalability, low transaction fees, and develo
 
 The **Chorus One SDK** simplifies this process, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+This guide will walk you through the fundamentals of staking on NEAR using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular NEAR libraries such as `near-api-js`. This compatibility ensures that you can seamlessly integrate these methods into your existing NEAR projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on NEAR using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on the NEAR network using the Chorus One SDK, you will first need to initialize the SDK for NEAR.

diff --git a/book/build-your-staking-dapp/polkadot-substrate/overview.md b/book/build-your-staking-dapp/polkadot-substrate/overview.md
@@ -8,16 +8,16 @@ The Substrate blockchain framework is known for its flexibility and modularity,
 
 The **Chorus One SDK** simplifies this process, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+This guide will walk you through the fundamentals of staking on Substrate using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular Substrate libraries such as `@polkadot/api`. This compatibility ensures that you can seamlessly integrate these methods into your existing Substrate projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on Substrate using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on the Substrate network using the Chorus One SDK, you will first need to initialize the SDK for Substrate.

diff --git a/book/build-your-staking-dapp/solana/overview.md b/book/build-your-staking-dapp/solana/overview.md
@@ -10,16 +10,16 @@ The Solana blockchain, distinguished by its high throughput and low latency, lev
 
 The **Chorus One SDK** simplifies the staking process on the Solana network, providing developers with the tools needed to build, sign, and broadcast staking transactions.
 
+This guide will walk you through the fundamentals of staking on Solana using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular Solana libraries such as `@solana/web3.js`. This compatibility ensures that you can seamlessly integrate these methods into your existing Solana projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on Solana using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on the Solana network using the Chorus One SDK, you will first need to initialize the SDK.

diff --git a/book/build-your-staking-dapp/ton/overview.md b/book/build-your-staking-dapp/ton/overview.md
@@ -13,16 +13,16 @@ It supports:
 - The official Nominator Pool smart contracts available for review on the official [TON Docs](https://docs.ton.org/participate/network-maintenance/nominators)
 - The official Single Nominator Pool smart contract available for review on the official [TON Docs](https://docs.ton.org/participate/network-maintenance/single-nominator)
 
+This guide will walk you through the fundamentals of staking on TON using the Chorus One SDK.
+
 {% hint style="info" %}
 
-### Compatibility Notice
+**Compatibility Notice**
 
 The methods provided in this documentation are compatible with popular TON libraries such as `@ton/ton`. This compatibility ensures that you can seamlessly integrate these methods into your existing TON projects.
 
 {% endhint %}
 
-This guide will walk you through the fundamentals of staking on TON using the Chorus One SDK.
-
 ## Setting Up the Staker
 
 To get started with staking on TON using the Chorus One SDK, you will first need to initialize the SDK.

diff --git a/book/ethereum-tutorial/3-staking.md b/book/ethereum-tutorial/3-staking.md
@@ -103,9 +103,7 @@ The `Transaction` object returned by `buildStakeTransaction` includes the follow
 - **`data` (Hex)**: A contract hashed method call with encoded arguments (the transformation of the method call into this encoded and hashed form is handled by the `encodeFunctionData` method from the viem library).
 - **`value` (bigint)**: The amount of ETH being used in the transaction. In this case, it's the amount being staked.
 
-{% hint style="warning" %}
-
-**Ensuring Correct Amount Format for Staking**
+### Ensuring Correct Amount Format for Staking
 
 The `amountToStake` parameter must be a string representing the amount of ETH to deposit. For example, `'1'` represents 1 ETH.
 
@@ -122,8 +120,6 @@ console.log(amountToStake) // "0.01"
 
 This ensures the `amountToStake` parameter is in the correct format for the staking transaction function.
 
-{% endhint %}
-
 {% hint style="info" %}
 **Configuring Fees**