Skip to content

Commit

Permalink
checkin updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
teslashibe committed Aug 28, 2024
1 parent 2ab6fba commit 5ffb0af
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 44 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: quickstart
title: Quickstart Guide
id: protocol-binary-installation
title: Protocol Binary Installation
---

This guide will help you set up and run a Masa Oracle node quickly.
This guide will help you set up and run a Masa Node ready for configuration and deployment.

### Prerequisites

Expand Down Expand Up @@ -110,52 +110,46 @@ Is TelegramScraper: false
You now have a running node in **Local Bootnode** configuration, you can now proceed to setup your node to start scraping data or to start participating in the network.

:::
## Masa Protocol Configuration
### Set Up a Data Scraper (Worker Node)
If you want your node to earn rewards configure it to to scrape data on the Masa Protocol.

### 7. Configure Your Node
- [Twitter Scraper Configuration](./twitter-scraper-setup.md)
- [Web Scraper Configuration](./web-scraper-setup.md)
- [Discord Scraper Configuration](./discord-scraper-setup.md)
- [Telegram Scraper Configuration](./telegram-scraper-setup.md)

Now that you have a running node, you can configure it for specific roles or functionalities. Choose one of the following paths based on your goals:
:::info

You need to have **setup** your node and **staked** your node first to be able to scrape data:

### Masa Bittensor Subnet Setup
:::

#### a) Set Up a Subnet Validator Node
If you want your node to validate subnet transactions:
- [Subnet Validator Configuration](./subnet-validator-node-setup.md)
### Get data from the Network (Developer Node)
AI developers can get data from the Masa Protocol for free by running a Masa node locally or by using our API (**coming soon**).

#### b) Set Up a Subnet Miner Node
If you want your node to participate in subnet mining:
- [Subnet Miner Node Configuration](./subnet-miner-node-setup.md)
- [Subnet Miner Node Digital Ocean Deployment Guide](./digital-ocean-setup.md)
- [Digital Ocean Performance Optimization](./digital-ocean-optimization.md)
- [Staking Your Node](./staking-guide.md)
- [Developer Playground](./validator-setup.md)

:::info

Masa operates on Bittensor subnet 42. You can view the network statistics and performance at [Taostats Subnet 42](https://x.taostats.io/subnet/42).
To get data from the Masa Protocol as a developer you need to stake your node (no free leech) - **you need Sepolia ETH** to stake.

:::

### Masa Protocol Setup
### Secure the Network (Validator Node)
Earn MASA rewards by securing the network:

#### a) Set Up a Data Scraper (Woker) Node
If you want your node to earn rewards by scraping data on the Masa Protocol:
- [Twitter Scraper Configuration](./twitter-scraper-setup.md)
- [Web Scraper Configuration](./web-scraper-setup.md)
- [Discord Scraper Configuration](./discord-scraper-setup.md)
- [Telegram Scraper Configuration](./telegram-scraper-setup.md)
- [Validator Configuration](./validator-setup.md)

#### b) Get data from the Network
To get data from the Masa Protocol as a developer you need to stake your node (no free leech):
- [Staking Your Node](./staking-guide.md)
- [Becoming a Validator](./validator-setup.md)

#### c) Advanced Configuration
### Advanced Configuration
For more detailed setup options:
- [Environment Configuration Guide](./environment-configuration.md)
- [Network Configuration Guide](./network-configuration.md)

#### d) Troubleshooting and Support
### Troubleshooting and Support
If you encounter any issues:
- [Common Issues and Solutions](./troubleshooting.md)
- [Community Support Channels](./community-support.md)

Choose the path that best fits your needs and follow the respective guide for detailed instructions.

Choose the path that best fits your needs and follow the respective guide for detailed instructions.
26 changes: 13 additions & 13 deletions docs/welcome-to-masa/welcome-to-masa.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Masa operates on Bittensors Subnet 42 (SN42). You can view the network statistic

## Masa Protocol
Learn how to set up a Masa node in your environment ready for configuration and deployment:
- [Masa Protocol Binary Installation](./quickstart.md)
- [Masa Protocol Docker Setup](./docker-setup.md)
- [Masa Protocol Digital Ocean Setup](./digital-ocean-setup.md)
- [Masa Protocol Binary Installation](./protocol-binary-installation.md)
- [Masa Protocol Docker Setup](./protocol-docker-setup.md)
- [Masa Protocol Digital Ocean Setup](./protocol-digital-ocean-setup.md)

### Staking Your Node
- [Staking Your Node](./staking-guide.md)
- [Staking Your Node](./protocol-staking-guide.md)

:::danger

Expand All @@ -44,10 +44,10 @@ All protocol nodes need to stake test MASA on Sepolia, this requires **Sepolia E
### Set Up a Data Scraper (Worker Node)
If you want your node to earn rewards configure it to to scrape data on the Masa Protocol.

- [Twitter Scraper Configuration](./twitter-scraper-setup.md)
- [Web Scraper Configuration](./web-scraper-setup.md)
- [Discord Scraper Configuration](./discord-scraper-setup.md)
- [Telegram Scraper Configuration](./telegram-scraper-setup.md)
- [Twitter Scraper Configuration](./protocol-twitter-scraper-setup.md)
- [Web Scraper Configuration](./protocol-web-scraper-setup.md)
- [Discord Scraper Configuration](./protocol-discord-scraper-setup.md)
- [Telegram Scraper Configuration](./protocol-telegram-scraper-setup.md)

:::info

Expand All @@ -58,8 +58,8 @@ You need to have **setup** your node and **staked** your node first to be able t
### Get data from the Network (Developer Node)
AI developers can get data from the Masa Protocol for free by running a Masa node locally or by using our API (**coming soon**).

- [Staking Your Node](./staking-guide.md)
- [Developer Playground](./validator-setup.md)
- [Staking Your Node](./protocol-staking-guide.md)
- [Developer Playground](./protocol-validator-setup.md)

:::info

Expand All @@ -70,12 +70,12 @@ To get data from the Masa Protocol as a developer you need to stake your node (n
### Secure the Network (Validator Node)
Earn MASA rewards by securing the network:

- [Validator Configuration](./validator-setup.md)
- [Validator Configuration](./protocol-validator-setup.md)

### Advanced Configuration
For more detailed setup options:
- [Environment Configuration Guide](./environment-configuration.md)
- [Network Configuration Guide](./network-configuration.md)
- [Environment Configuration Guide](./protocol-environment-configuration.md)
- [Network Configuration Guide](./protocol-network-configuration.md)

### Troubleshooting and Support
If you encounter any issues:
Expand Down

0 comments on commit 5ffb0af

Please sign in to comment.