Skip to content

Commit

Permalink
FE-1044 Feature/url fixes (#132)
Browse files Browse the repository at this point in the history
* Fix ' vs ", fix indentation and fix mobile-app related URLs.

* Fix Rewards-related URLs

* Update Glossary and FAQ

* Fix D1 and deployment URLs.

* Remove unnecessary parameters in document init (e.g. slug, id, hide_title=false etc)

* Add redirection URLs for D1

* Update Pulse URLs

* Update Helium URLs

* Update M5 URLs

* Move all redirects to an explicit file redirects.js

* Fix URL in home
  • Loading branch information
PavlosTze committed Jul 30, 2024
1 parent 686b3aa commit 47970b2
Show file tree
Hide file tree
Showing 54 changed files with 513 additions and 475 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ jobs:
with:
node-version: 20.x
cache: yarn

- name: Install dependencies
run: yarn install --immutable
- name: Build website
run: yarn build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
18 changes: 0 additions & 18 deletions .github/workflows/dev-docs-deployment.yaml

This file was deleted.

1 change: 0 additions & 1 deletion .github/workflows/test-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ jobs:
with:
node-version: 20.x
cache: yarn

- name: Install dependencies
run: yarn install --immutable
- name: Test build website
Expand Down
11 changes: 4 additions & 7 deletions docs/help-center/faq.mdx → docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
id: faqs
title: Help Center / FAQ
hide_title: false
sidebar_label: Help Center / FAQ
slug: /faqs
---

import useBaseUrl from "@docusaurus/useBaseUrl";
Expand All @@ -24,7 +21,7 @@ The station will appear in your station list.

### How do you know people are not faking the location of their station on the map?

In addition to the cryptographic proofs from all station data sent to the WeatherXM Network, we have designed and implemented a unique Proof of Location algorithm to safeguard the accuracy of the weather station location. Read more at the [PoL section of the documentation](/project/proof-of-location).
In addition to the cryptographic proofs from all station data sent to the WeatherXM Network, we have designed and implemented a unique Proof of Location algorithm to safeguard the accuracy of the weather station location. Read more at the [PoL section of the documentation](/rewards/proof-of-location).

## <Highlight color="#68a4f9">Hardware</Highlight>

Expand Down Expand Up @@ -52,7 +49,7 @@ You can connect your WeatherXM Helium compatible station anywhere with Helium ne
### Will it make a big difference if I place my station on the balcony instead of the roof?

It is mandatory that you place your station on the roof and the reason is because there aren't so many obstacles as there are on a balcony (e.g walls), that will reduce the quality of your data, therefore the amount of your rewards.
You can also check the [deployment examples](/deployment-examples) for inspiration.
You can also check the [deployment examples](/wxm-devices/deployment-examples) for inspiration.

<hr />

Expand All @@ -70,13 +67,13 @@ We approximately follow the [frequency assignments of TTN per country](https://w

### How can I start receiving rewards?

If you have already set up your station and claimed your device via the app, please add Metamask and follow the instructions [here](/wallet/add-edit-wallet-address) and then follow this guide to [claim your rewards](/project/rewards-claiming).
If you have already set up your station and claimed your device via the app, please add Metamask and follow the instructions [here](/mobile-app/wallet/add-edit-wallet-address) and then follow this guide to [claim your rewards](/rewards/rewards-claiming).

<hr />

### How can I check my rewards?

You can check your rewards by using our mobile App and follow this guide to [claim your rewards](/project/rewards-claiming).
You can check your rewards by using our mobile App and follow this guide to [claim your rewards](/rewards/rewards-claiming).

<hr />

Expand Down
2 changes: 0 additions & 2 deletions docs/glossary/glossary.mdx → docs/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: glossary
title: Glossary of Common Terms
sidebar_label: Glossary of Common Terms
slug: /glossary
---

| Term | Description |
Expand Down
16 changes: 7 additions & 9 deletions docs/home.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
id: home
title: Homepage
hide_title: true
sidebar_label: Home
slug: /
hide_table_of_contents: false
---

import useBaseUrl from "@docusaurus/useBaseUrl";
Expand All @@ -17,7 +15,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech

<section class="product-container">
<div class="device">
<Link to="/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction">
<Link to="/wxm-devices/m5/introduction">
<img src={useBaseUrl("img/home/m5-bundle.png")} />
<div class="device-info">
<h4>WeatherXM M5 bundle (WB1000)</h4>
Expand All @@ -26,7 +24,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
</Link>
</div>
<div class="device">
<Link to="/wxm-devices/helium-bundle/wxm-ws2000-introduction">
<Link to="/wxm-devices/helium/introduction">
<img src={useBaseUrl("/img/home/helium.png")} />
<div class="device-info">
<h4>WeatherXM Helium station (WS2000)</h4>
Expand All @@ -38,7 +36,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech

<section class="product-container">
<div class="device" >
<Link to="wxm-devices/D1-bundle/D1-bundle-introduction">
<Link to="/wxm-devices/d1/introduction">
<img src={useBaseUrl("/img/home/d1-bundle.png")} />
<div class="device-info" >
<h4>WeatherXM D1 bundle (WB1200)</h4>
Expand All @@ -47,7 +45,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
</Link>
</div>
<div class="device">
<Link to="/wxm-devices/pulse-bundle/introduction">
<Link to="/wxm-devices/pulse/introduction">
<img src={useBaseUrl("/img/home/pulse-bundle.png")} />
<div class="device-info">
<h4>WeatherXM Pulse bundle (WB3000)</h4>
Expand All @@ -71,11 +69,11 @@ This documentation site attempts to explain various aspects of the WeatherXM pro

<Link to="/tokenomics">&#8226; The $WXM Token</Link>
<br></br>
<Link to="/reward-mechanism/">&#8226; Reward Mechanism</Link>
<Link to="/rewards/reward-mechanism/">&#8226; Reward Mechanism</Link>
<br></br>
<Link to="/project/quality-of-data/">&#8226; Quality of Data (QoD)</Link>
<Link to="/rewards/quality-of-data/">&#8226; Quality of Data (QoD)</Link>
<br></br>
<Link to="/project/proof-of-location/">&#8226; Proof of Location (PoL)</Link>
<Link to="/rewards/proof-of-location/">&#8226; Proof of Location (PoL)</Link>
<br></br><br></br>
Join our <Link to="https://weatherxm.com/discord">Discord Community Server</Link>.

18 changes: 8 additions & 10 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
id: introduction
title: Introduction
hide_title: true
sidebar_label: Introduction
slug: /introduction
hide_table_of_contents: true
---

Expand Down Expand Up @@ -33,26 +31,26 @@ You can stay updated on the current state of the network by checking out our [ex
Some significant milestones we have achieved so far:

### Reward Mechanism
Current [Reward Mechanism v2.0](/reward-mechanism) includes significant improvements over previous versions.
Current [Reward Mechanism v2.0](/rewards/reward-mechanism) includes significant improvements over previous versions.
Business Boost rewards have been added, with predefined criteria for fairness.
A Merkle Tree structure has been implemented for transparent reward distribution.
Users can withdraw their rewards whenever they choose to do so.
The Merkle Tree structure facilitates a verifiable and transparent mechanism for users to validate reward distribution.
These improvements aim to refine the Reward Mechanism, making it more inclusive, nuanced, and transparent to build trust among weather station owners participating in the network.
More on [Reward Mechanism](/reward-mechanism).
More on [Reward Mechanism](/rewards/reward-mechanism).

### Quality of Data (QoD)
[Quality of Data (QoD)](/project/quality-of-data) is an algorithm that assesses the quality of weather data provided by a weather station. The score it generates shows how confident we can be in the quality of the data received. Our goal is to make sure that the data we receive is meaningful and usable, and the QoD score helps us measure this metric. Ultimately, we want to encourage weather station owners to follow our guidelines so that they can consistently achieve the best possible QoD score.
[Quality of Data (QoD)](/rewards/quality-of-data) is an algorithm that assesses the quality of weather data provided by a weather station. The score it generates shows how confident we can be in the quality of the data received. Our goal is to make sure that the data we receive is meaningful and usable, and the QoD score helps us measure this metric. Ultimately, we want to encourage weather station owners to follow our guidelines so that they can consistently achieve the best possible QoD score.

To achieve this, QoD relies on a range of techniques and processes designed to help us differentiate between expected and unexpected data behaviors.
More on [Quality of Data](/project/quality-of-data).
More on [Quality of Data](/rewards/quality-of-data).

### WeatherXM Devices
Currently we use 4 main types of devices:
- [WeatherXM M5 Bundle (WB1000)](/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction) which is the WiFi version
- [WeatherXM Helium Version (WS2000) ](/wxm-devices/helium-bundle/wxm-ws2000-introduction) which is the Helium version
- [WeatherXM D1 bundle (WB1200)](/wxm-devices/D1-bundle/D1-bundle-introduction) which is the upgraded WiFi version
- [WeatherXM Pulse bundle (WB3000)](/wxm-devices/pulse-bundle/introduction) which is the 4G/LTE version
- [WeatherXM M5 Bundle (WB1000)](/wxm-devices/m5/introduction) which is the WiFi version
- [WeatherXM Helium Version (WS2000) ](/wxm-devices/helium/introduction) which is the Helium version
- [WeatherXM D1 bundle (WB1200)](/wxm-devices/d1/introduction) which is the upgraded WiFi version
- [WeatherXM Pulse bundle (WB3000)](/wxm-devices/pulse/introduction) which is the 4G/LTE version



Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
id: change-password
title: How to change password to your account
hide_title: false
sidebar_label: Change Password
slug: /account/change-password
---

import Tabs from "@theme/Tabs";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
id: delete-account
title: Delete WXM Account
hide_title: false
sidebar_label: Delete WXM Account
slug: /account/delete-account
---

import Tabs from "@theme/Tabs";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
id: add-edit-wallet-address
title: Add/edit wallet address
hide_title: false
sidebar_label: Add/edit wallet address
slug: /wallet/add-edit-wallet-address
---

import Tabs from "@theme/Tabs";
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from "@docusaurus/useBaseUrl";

:::tip
If you don’t have a wallet, [create one](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens.
If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens.
:::


Expand Down
4 changes: 1 addition & 3 deletions docs/rewards/cell-capacity.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
---
id: cell-capacity
title: Cell Capacity (CC)
sidebar_label: Cell Capacity (CC)
slug: /project/cell-capacity
---

**Cell Capacity (CC)** is a parameter that is used to define the maximum number of stations that may receive rewards in a specific cell.

Each cell has a predetermined capacity that depends on its unique geospatial features. The capacity of a cell is the maximum number of weather stations that are eligible for rewards in that particular cell.
If there are 'N' rewardable weather stations in a cell with a capacity of 'CC' on a given day, and if N exceeds CC, then only the first N stations
(ordered first by their reward score, defined in the [Reward Mechanism (RM) ](/reward-mechanism) section, and then by seniority) will receive rewards.
(ordered first by their reward score, defined in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section, and then by seniority) will receive rewards.

:::tip
Cell capacity is a parameter that is used to define the maximum number of stations that are eligible for rewards in a specific cell. Every cell has a predefined capacity that depends on its geospatial characteristics*.
Expand Down
2 changes: 0 additions & 2 deletions docs/rewards/hardware-class.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: hardware-class
title: Hardware Class
sidebar_label: Hardware Class
slug: /project/hardware-class
---

Hardware-Class Weight (HCW): HCW is a rational number > 0.
Expand Down
4 changes: 1 addition & 3 deletions docs/rewards/how-to-join-arbitrum-and-see-your-tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
id: how-to-join-arbitrum-and-see-your-tokens
title: How to join Arbitrum and see your tokens
sidebar_label: How to join Arbitrum and see your tokens
slug: /rewards/how-to-join-arbitrum-and-see-your-tokens
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import useBaseUrl from "@docusaurus/useBaseUrl";

:::tip
If you don’t have a wallet, [create one](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens.
If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens.
:::

## Add Arbitrum One Network to Metamask
Expand Down
2 changes: 0 additions & 2 deletions docs/rewards/proof-of-location.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: proof-of-location
title: Proof of Location (PoL)
sidebar_label: Proof of Location (PoL)
slug: /project/proof-of-location
---

The **Proof-of-Location** algorithm evaluates location data associated with the station, their accuracy, and consistency. It generates a score which is a confidence indicator about the station’s location. WeatherXM places great importance on station continuity, and discourage relocations.
Expand Down
2 changes: 0 additions & 2 deletions docs/rewards/quality-of-data.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
id: quality-of-data
title: Quality of Data (QoD)
sidebar_label: Quality of Data (QoD)
slug: /project/quality-of-data
---

:::info
Expand Down
8 changes: 3 additions & 5 deletions docs/rewards/reward-boosts.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
id: reward-boosts
title: Reward Boosts
sidebar_label: Reward Boosts
slug: /project/reward-boosts
---

import useBaseUrl from "@docusaurus/useBaseUrl";


## Overview

**Reward boosts** are additional rewards given to stations that contribute weather data during daily distribution, in addition to the [**base rewards**](/reward-mechanism#daily-rewards-calculation-process). Learn more about the daily rewards in the [Reward Mechanism (RM) ](/reward-mechanism) section.
**Reward boosts** are additional rewards given to stations that contribute weather data during daily distribution, in addition to the [**base rewards**](/rewards/reward-mechanism#daily-rewards-calculation-process). Learn more about the daily rewards in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section.

**Reward Boosts** reward stations with extra $WXM tokens for meeting specific criteria.

Expand Down Expand Up @@ -57,7 +55,7 @@ The project's Beta period officially ended on May 27th (UTC). All station-hours
Download the BRT here: [CSV](https://weatherxm.network/wxm-brt-final.csv)

:::info
Each user who has a station eligible for beta rewards, must have a wallet defined to be part of the Beta Rewards allocation. Learn [how to add or edit a wallet address](/wallet/add-edit-wallet-address).
Each user who has a station eligible for beta rewards, must have a wallet defined to be part of the Beta Rewards allocation. Learn [how to add or edit a wallet address](/mobile-app/wallet/add-edit-wallet-address).
:::

:::note
Expand All @@ -70,7 +68,7 @@ Cell Boost is a mechanism that can be used to incentivise weather stations deplo

## Examples of reward programs that may be implemented using **Rewards Boost**, in the near future are:

- Backfill of rewards that were not allocated to certain devices due to malfunctions in the [Quality of Data (QoD) mechanism](/project/quality-of-data) or [Proof of Location (PoL) mechanism](/project/proof-of-location).
- Backfill of rewards that were not allocated to certain devices due to malfunctions in the [Quality of Data (QoD) mechanism](/rewards/quality-of-data) or [Proof of Location (PoL) mechanism](/rewards/proof-of-location).
- Public Goods Funding, for devices that are deployed and contribute to the network in a humanitarian way, such as providing data in an underserved area or during a specific time.
- Devices that contribute to the network during a specific event, such as a natural disaster, may receive a boost in rewards.

Expand Down
Loading

0 comments on commit 47970b2

Please sign in to comment.