Skip to content

Commit

Permalink
Merge pull request #155 from rsksmart/docs/maintenance-fixes-05
Browse files Browse the repository at this point in the history
Docs Maintenance Fixes for November (05)
  • Loading branch information
owans authored Nov 18, 2024
2 parents 0970857 + c5008d9 commit 00ff0dc
Show file tree
Hide file tree
Showing 18 changed files with 35 additions and 36 deletions.
6 changes: 6 additions & 0 deletions docs/04-resources/06-guides/runes-rootstock/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
label: Runes on Rootstock
position: 1
link:
type: generated-index
description: The Rootstock Runes Mock Bridge Project opens up exciting opportunities for developers to build Runes-focused applications within the Rootstock ecosystem.
slug: /resources/guides/runes-rootstock/
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 201
title: Introduction to Airdrops on Bitcoin
sidebar_label: Introduction
tags: [rsk, rootstock, resources, tutorials, runes, nft, Ethereum, dApps, smart contracts, airdrop]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
label: Build A Giveaway Airdrop Machine on Rootstock
position: 5
link:
type: generated-index
description: This guide will focus on building a giveaway airdrop machine on the Rootstock network, highlighting how they function and the unique benefits they offer to users. A particular focus will be on the Runes Giveaway Machine Airdrop Claim, where you will learn how to install and use this innovative tool to claim your tokens easily.
slug: /resources/guides/runes-rootstock/airdrop-giveaway-machine/
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
---
sidebar_position: 3
sidebar_position: 204
title: Deploying the Airdrop Machine Smart Contract Using Remix IDE
sidebar_label: Deploy Airdrop Machine
sidebar_label: Deploy Airdrop Giveaway Machine
tags: [rsk, rootstock, resources, tutorials, runes, nft, Ethereum, dApps, smart contracts, airdrop]
description: "This guide will walk you through deploying the Airdrop Machine smart contract using Remix IDE. The Airdrop Machine is designed to distribute tokens across multiple addresses, supporting both standard and Merkle tree-based airdrops.
"
description: "This guide will walk you through deploying the Airdrop Machine smart contract using Remix IDE. The Airdrop Machine is designed to distribute tokens across multiple addresses, supporting both standard and Merkle tree-based airdrops."
---

This section will walk you through deploying the Airdrop Machine smart contract using Remix IDE. The Airdrop Machine is designed to distribute tokens across multiple addresses, supporting both standard and [Merkle tree-based](https://www.investopedia.com/terms/m/merkle-tree.asp) airdrops.

By following these instructions, you'll learn how to clone the necessary repository, prepare the contracts, and deploy them in Remix IDE.

## **Step 1: Clone the Repository**

Clone the Airdrop template repository from the link below:
```

```bash
git clone https://github.com/rsksmart/airdrop-template.git
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
sidebar_position: 2
title: Setup Airdrop Machine
sidebar_label: Setup Airdrop Machine
sidebar_position: 203
title: Setup Your Own Airdrop Giveaway Machine
sidebar_label: Setup Your Own Airdrop Giveaway Machine
tags: [rsk, rootstock, resources, tutorials, runes, nft, Ethereum, dApps, smart contracts, airdrop]
description: "This shows you steps to set up your airdrop giveaway machine"
description: "This shows you the steps needed to setup your own airdrop giveaway machine."
---

## **Prerequisite**
Expand All @@ -17,7 +17,7 @@ Before going further in this guide, it's essential to have the following foundat
3. **Git Installation:**
* Ensure that Git is installed on your machine. Familiarity with Git will help you manage version control effectively, collaborate with others, and track changes to your code.

#### **Installation**
### **Installation**

To install and run the Runes giveaway machine Airdrop claim locally, follow these steps:

Expand All @@ -43,7 +43,7 @@ NEXT_PUBLIC_RPC_URL=<your_rpc_url>
NEXT_PUBLIC_EXPLORER=<your_blockchain_explorer>
```

### Explanation with added context for each environment variable:
## Explanation with added context for each environment variable

```
NEXT_PUBLIC_AIRDROP_MANAGER_ADDRESS=<your_airdrop_manager_address>
Expand All @@ -53,7 +53,7 @@ This variable specifies the address of the Airdrop Manager smart contract. To en

:::info[Info]

For detailed instructions on obtaining the Airdrop Manager address, please refer to the [Deploy](docs/04-resources/09-Airdrop/deploy.md) section
For detailed instructions on obtaining the Airdrop Manager address, please refer to the [Deployment](/resources/guides/runes-rootstock/airdrop-giveaway-machine/deploy-airdrop-machine.md) section.

:::

Expand Down Expand Up @@ -89,7 +89,7 @@ npm run dev

Once installed, this project can be used to claim airdrops via a decentralized application, adding another layer of utility to the Bitcoin ecosystem.

## **Frontend Integration Guide**
## Interacting with the Frontend

Once you have the application running locally, follow these steps to interact with the airdrop functionality:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 202
title: Overview of the Airdrop Template Repository
sidebar_label: Airdrop Machine Template Repository

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
label: Create and Deploy a Runes Mock Bridge dApp on Rootstock
position: 4
link:
type: generated-index
description: The Rootstock Runes Mock Bridge project opens up exciting opportunities for developers to build Runes-focused applications within the Rootstock ecosystem.
slug: /resources/guides/runes-rootstock/deploy-mockbridge-contract/
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ tags: [rsk, rootstock, resources, tutorials, setup, Runes, dApps, smart contrac
description: "The Rootstock Runes Mock Bridge setup page shows you how to getting building your runes, by first cloning our project and testing it locally."
---

## **Prerequisites**

Before getting started with the Runes Mock Bridge, ensure you have the following prerequisites in place:
Before getting started with the Runes Mock Bridge Project, ensure to setup the following:

1. **Familiarity with Remix IDE**
You should have a basic understanding of how to use Remix IDE, an online platform for writing, compiling, and deploying Solidity smart contracts.
Expand Down
6 changes: 0 additions & 6 deletions docs/04-resources/06-guides/runes/_category_.yml

This file was deleted.

6 changes: 0 additions & 6 deletions docs/04-resources/06-guides/runes/airdrop/_category_.yml

This file was deleted.

6 changes: 0 additions & 6 deletions docs/04-resources/06-guides/runes/mockbridge/_category_.yml

This file was deleted.

Binary file modified static/img/og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 00ff0dc

Please sign in to comment.