Merge pull request #2 from CoinFabrik/special-features

README.md

@@ -29,7 +29,8 @@ XLink's functionality is detailed across various sections in our documentation.
   
 - **Getting Started**
   - [Prerequisites](getting-started/prerequisites.md): Essential requirements to begin using the XLink bridge.
-  - [Quickstart: Using the Bridge](getting-started/using-the-bridge.md): Step-by-step guide to initiate asset transfers.
+  - [Quickstart: The Bridge](getting-started/the-bridge.md): Step-by-step guide to initiate asset transfers.
+  - [Quickstart: Campaigns](getting-started/campaigns.md): A detailed guide on how to participate in XLink campaigns and earn rewards.
   - [Guides](getting-started/guides/README.md): Practical walkthroughs, including [How to Connect Your Wallet](getting-started/guides/how-to-connect-your-wallet.md).
 
 - **Integrations**
@@ -42,4 +43,4 @@ XLink's functionality is detailed across various sections in our documentation.
 
 ## Support
 
-For assistance, feel free to join our community on [Discord](https://discord.com/invite/xlink) or [Telegram](https://x.com/XLinkbtc).
+For assistance, feel free to join our community on [Discord](https://discord.com/invite/xlink).

SUMMARY.md

@@ -9,10 +9,11 @@
 
 - [Getting Started](getting-started/README.md)
   - [Prerequisites](getting-started/prerequisites.md)
-  - [Quickstart: Using the Bridge](getting-started/using-the-bridge.md)
+  - [Quickstart: The Bridge](getting-started/the-bridge.md)
+  - [Quickstart: Campaigns](getting-started/campaigns.md)
   - [Guides](getting-started/guides/README.md)
     - [How to Connect your Wallet](getting-started/guides/how-to-connect-your-wallet.md)
-
+   
 - [Reserves](reserves.md)
 
 - [Integrations](integrations/README.md)

getting-started/README.md

@@ -22,9 +22,10 @@ XLink enables seamless asset transfers across blockchains, keeping you in contro
 ## Explore
 
  - [Prerequisites](prerequisites.md): Essential requirements to begin using the XLink bridge.
-  - [Quickstart: Using the Bridge](using-the-bridge.md): Step-by-step guide to initiate asset transfers.
+  - [Quickstart: The Bridge](the-bridge.md): Step-by-step guide to initiate asset transfers.
+  - [Quickstart: Campaigns](campaigns.md): A detailed guide on how to participate in XLink campaigns and earn rewards.
   - [Guides](./guides/README.md): Practical walkthroughs, including [How to Connect Your Wallet](./guides/how-to-connect-your-wallet.md).
 
 ## Support
 
-For help, join us on [Discord](https://discord.com/invite/xlink) or [Telegram](https://x.com/XLinkbtc).
+For help, join us on [Discord](https://discord.com/invite/xlink).

getting-started/campaigns.md

@@ -0,0 +1,94 @@
+---
+description: Learn what are and how to participate in XLink campaigns and earn rewards.
+layout:
+  title:
+    visible: true
+  description:
+    visible: true
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: false
+---
+
+# Campaign Guide
+
+## What are XLink Campaigns
+
+Welcome to the **Campaigns**! XLink campaigns are special events where users can participate in various actions on supported blockchains to earn rewards. These actions typically involve interacting with many different actors in the STACKS ecosystem, like the XLink bridge, and use them to accomplish different challenges. Campaigns offer great opportunities to earn **ALEX**, **LiSTX**, **XLink Points**, and other project-specific tokens as rewards.
+
+Each campaign involves different requirements and actions, and all aim to incentivize user participation and strengthen user confidence in the Bitcoin DeFi ecosystem. Below, we'll explore the rewards you can earn and some tips on how to maximize your participation.
+
+## How do XLink Campaigns work
+
+Campaigns work by offering users the chance to earn rewards for completing specific tasks across different blockchains. Here's a quick overview:
+
+- **Actions**: Users typically need to perform tasks like staking, adding liquidity, or bridging assets.
+- **Rewards**: In return, participants can earn tokens such as **ALEX**, **LiSTX**, **XLink Points**, or project-specific tokens like **aBTC** and **MODE Points**.
+- **Platforms**: Campaigns can be hosted on various platforms like CORE, Mode, or Stacks, and often involve bridging assets between blockchains to complete the tasks.
+
+## Typical Rewards in XLink Campaigns
+
+XLink campaigns offer a variety of rewards based on the campaign and the blockchain involved. Here are some common rewards you can earn:
+
+- **ALEX**: Earn ALEX by participating in campaigns on the Stacks or Ethereum blockchains.
+- **LiSTX**: A popular reward on Stacks campaigns, allowing users to stake and earn additional tokens.
+- **XLink Points**: Earn XLink Points by bridging assets and completing actions.
+- **Project-Specific Tokens**: Earn tokens tied to the specific blockchain you're interacting with (e.g., **aBTC**, **MODE Points**).
+
+## Tips for Participating in Campaigns
+
+- **Check the Requirements**: Each campaign has different requirements, so be sure to review the campaign details before you start.
+- **Stay Updated**: New campaigns are launched regularly. Keep an eye on the XLink platform or join our community channels for the latest updates.
+- **Plan Ahead**: Some campaigns offer better rewards for specific actions (e.g., staking certain tokens or adding liquidity). Plan to maximize your rewards!
+
+## Where to Find Campaigns
+
+To view and join active campaigns, visit the [**XLink Campaigns Page**](https://app.xlink.network/bridge-campaign). You’ll find detailed instructions, the supported tokens, and the rewards for each campaign.
+
+## How to Participate in XLink Campaigns
+
+Participating in campaigns is easy and rewarding. Although each campaign might be slightly different, the basic steps to participate are similar. Here’s how you can get started:
+
+### Step 1: **Register on the Platform**
+First, visit the **XLink App** and navigate to the **Campaigns** tab. This is where you'll find all the active campaigns. 
+
+Look for the **See Details** button next to the campaign you're interested in. Clicking it will provide more details on how to participate, including specific steps and links to register.
+
+![Campaign Browsing](../.gitbook/assets/campaigns/campaigns-menu.png)
+
+Once you've selected a campaign, you'll need to register for it by following the instructions provided under the **How to Participate** section. You might be directed to specific platforms like **CORE**, **Mode**, or **Stacks**, depending on the campaign.
+
+For example, in the **ALEX Staking Campaign**, you'll be directed to stake your ALEX tokens on LISA. Follow the campaign-specific instructions to complete the staking process and earn rewards.
+
+![ALEX Staking Campaign Example](../.gitbook/assets/campaigns/alex-staking-example.png)
+
+Similarly, in the **ALEX Liquidity Campaign**, you’ll be directed to add liquidity on a supported DeFi platform. Be sure to follow the specific steps outlined in each campaign.
+   
+### Step 2: **Bridge Your Assets** (If Required)
+Next, you’ll typically bridge assets from one blockchain to another, depending on the campaign. This could include tokens like **aBTC**, **WBTC**, or other supported assets. Make sure to check the campaign’s instructions on which assets to bridge and to which chain.
+
+*Note*: Not all campaigns require bridging assets, so always check the campaign details first.
+
+   <!-- *screenshot here showing the bridge interface and how to select assets for bridging.*
+   ![Bridge Assets](../.gitbook/assets/special-features/bridge-assets.png) -->
+
+### Step 3: **Complete the Required Action**
+Once your assets are bridged, you may need to perform additional actions like re-staking your tokens, adding liquidity to a pool, or borrowing/supplying tokens on a DeFi platform. These actions unlock the campaign rewards.
+
+*Note*: The actions required in each campaign can vary, so be sure to check the campaign details for specific requirements.
+  
+  <!-- *screenshot here showing an example of completing an action like staking or adding liquidity.* 
+  ![Staking and Liquidity](../.gitbook/assets/special-features/staking-liquidity.png) -->
+
+### Step 4: **Earn Rewards**
+After completing the necessary steps, you'll start earning rewards like **ALEX**, **LiSTX**, **XLink Points**, or other project-specific tokens.
+   
+  <!-- *screenshot here showing how rewards are tracked or where users can see their earned rewards.*
+  ![Earn Rewards](../.gitbook/assets/special-features/earn-rewards.png) -->
+
+## Need Help?
+
+If you have any questions or need help with a campaign, join our community on [**Discord**](https://discord.com/invite/xlink).

getting-started/guides/README.md

@@ -25,4 +25,4 @@ More guides coming soon to assist with managing assets, bridging tokens, and mor
 
 ## Support
 
-For assistance, join our community on [Discord](https://discord.com/invite/xlink) or [Telegram](https://x.com/XLinkbtc).
+For assistance, join our community on [Discord](https://discord.com/invite/xlink).

getting-started/the-bridge.md

@@ -89,4 +89,4 @@ You can monitor your transaction in real-time by clicking the **View in explorer
 
 ## Support
 
-For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/xlink) and [Telegram](https://x.com/XLinkbtc).
+For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/xlink).

overview/README.md

@@ -27,4 +27,4 @@ XLink is a cross-chain bridge enabling seamless asset transfers across multiple
 
 ## Support
 
-For help, join us on [Discord](https://discord.com/invite/xlink) or [Telegram](https://x.com/XLinkbtc).
+For help, join us on [Discord](https://discord.com/invite/xlink).

special-features/README.md

@@ -0,0 +1,31 @@
+---
+description: Discover the special features of the XLink cross-chain bridge!
+layout:
+  title:
+    visible: true
+  description:
+    visible: true
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: false
+---
+
+# ✨ Special Features
+
+XLink doesn't just help you transfer assets between blockchains securely, it also comes with extra features. These special features are here to give you more options to interact with the XLink bridge.
+
+## 🔍 Explore
+
+- **📖 [Campaign Guide](./campaigns-guide.md):** A detailed guide on how to participate in XLink campaigns and earn rewards.
+
+## 🚀 What's Coming?
+
+XLink is always evolving, and we have more exciting features on the way! Stay tuned as we continue to add new ways for you to engage with the platform.
+
+## 💬 Need Help?
+
+If you have any questions or need support, our community is here to help!  
+Join us on [**Discord**](https://discord.com/invite/xlink).