Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

refactor: "Become a delegator" > "Stake RON" #251

Merged
merged 2 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@

##### Examples of how-to guides

* [Become a delegator](./delegators/onboarding/become-delegator.mdx)
* [Stake RON](./delegators/onboarding/become-delegator.mdx)
* [Run a validator node](./validators/setup/mainnet/run-validator.md)
* [Claim rewards](./validators/manage/claim-rewards.mdx)
* Task topics within other pages:
Expand Down Expand Up @@ -772,8 +772,8 @@

Ronin uses the [Google](https://github.com/errata-ai/google) style for the
[Google developer documentation style guide](https://developers.google.com/style).
The style definitions are located in the `/static/styles` directory,
and the Vale config lives in `/.vale.ini`.
The style definitions are located in the `./github/styles` directory,

Check notice on line 775 in docs/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/CONTRIBUTING.md#L775

[Google.Passive] In general, use active voice instead of passive voice ('are located').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are located').", "location": {"path": "docs/CONTRIBUTING.md", "range": {"start": {"line": 775, "column": 23}}}, "severity": "INFO"}
and the Vale config lives in `.vale.ini`.

## Self-review checklist

Expand All @@ -790,8 +790,7 @@
the style guide.
* [ ] Ensure technical accuracy of the content. Try to test your tasks and run
all commands by yourself.
* [ ] Run [Vale](#run-vale) in your Markdown files to check adherence to the
[style guide](./community/contribute/style-guide.md).
* [ ] Run [Vale](#run-vale) to lint your Markdown files.
* [ ] Spot and fix any grammar and spelling errors. Vale might not highlight
those.
* [ ] If there are any failing checks in your PR, such as broken links,
Expand Down
6 changes: 3 additions & 3 deletions docs/apps/ron-staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ RON Staking is an app where RON holders can delegate their tokens to validators,

Key features:

* Stake RON to validators: RON holders can stake their tokens to any validator and earn rewards.
* Manage your stake: RON holders can increase or withdraw their stake from a validator, or move it to a different validator.
* Claim rewards: RON holders can claim rewards for staking their tokens.
* [Stake RON](./../delegators/onboarding/become-delegator.mdx) to validators: RON holders can stake their tokens to any validator and earn rewards.
* [Manage your stake](./../delegators/manage/increase-withdraw-stake.mdx): RON holders can increase or withdraw their stake from a validator, or move it to a different validator.
* [Claim rewards](./../delegators/manage/claim-rewards.mdx): RON holders can claim rewards for staking their tokens.

Link: [https://app.roninchain.com/staking](https://app.roninchain.com/staking).

Expand Down
2 changes: 1 addition & 1 deletion docs/basics/key-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Staking is the process through which a Ronin user "stakes" or locks their crypto

Ronin's DPoS allows users to commit their RON as votes, where voting power is proportional to the number of coins held. These votes are then used to elect a number of validators who manage the blockchain on behalf of their voters, ensuring security and consensus. The staking reward is distributed to these elected validators, who then redistribute part of the reward to the users who staked their tokens proportionally to their individual contributions.

For instructions on staking on Ronin, see [Become a delegator](../delegators/onboarding/become-delegator.mdx).
For instructions on staking on Ronin, see [Stake RON](../delegators/onboarding/become-delegator.mdx).

## T

Expand Down
4 changes: 2 additions & 2 deletions docs/basics/roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ description: Who are delegators, validators, and bridge operators, and what they

A delegator is an individual that delegates their stake to a validator and earns rewards in return. By delegating their stake, delegators can participate in the network and be rewarded without the technical expertise or resources required to run a validator node themselves.

### Become a delegator
### Stake RON

In Ronin, token holders can choose validators based on various factors such as the performance of the validators and their commission rate.

After choosing the validators, the RON holders can follow the steps in [Register as a delegator](./../delegators/onboarding/become-delegator.mdx).
After choosing the validators, the RON holders can follow the steps in [Stake RON](./../delegators/onboarding/become-delegator.mdx).

## Validator

Expand Down
2 changes: 1 addition & 1 deletion docs/delegators/manage/increase-withdraw-stake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page demonstrates how to increase, move, or withdraw your existing stake.

## Before you start

Before managing your stake, you need to [become a delegator](./../onboarding/become-delegator.mdx).
Make sure you [staked some RON](./../onboarding/become-delegator.mdx).

## Stake more

Expand Down
48 changes: 28 additions & 20 deletions docs/delegators/onboarding/become-delegator.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Delegate your RON tokens to a validator.
title: Register as a delegator
description: Stake your RON tokens to a validator to earn staking rewards.
title: Stake RON
---

import myStaking from './assets/my-staking.png';
Expand All @@ -13,47 +13,55 @@

## Overview

This guide demonstrates how to delegate your RON stake to a validator
and how to view all your delegations. The delegation tutorial is provided in
This guide demonstrates how to stake your RON tokens to a validator
and how to view all your stakes. Staking is also referred to as "delegation," wherein you delegate your stake of RON to a validator to earn staking rewards.

The instruction is provided in

Check notice on line 19 in docs/delegators/onboarding/become-delegator.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/delegators/onboarding/become-delegator.mdx#L19

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "docs/delegators/onboarding/become-delegator.mdx", "range": {"start": {"line": 19, "column": 17}}}, "severity": "INFO"}
two formats: [video](#video) and [text](#text).

## Before you start

[Have RON tokens](./../../basics/buy-ron.mdx) in your Ronin Wallet.

## Delegate RON
### Video tutorial {#video}
## Stake RON

### Video instruction {#video}

Learn how to stake your RON with this official Staking Tutorial.
Learn how to stake your RON with this official staking tutorial.
<div class='embed-container'><iframe src='https://www.youtube.com/embed/rCSA6edBub8' frameborder='0' allowfullscreen></iframe></div>

### Text tutorial {#text}
### Text instruction {#text}

1. Go to [RON staking](https://app.roninchain.com/staking) >
**Connect wallet**.
<img src={stepOne} width={1440} />
<img src={stepOne} width={1440} />

2. Switch to the **All validators** tab, then pick a validator
you want to delegate to, and then select **Delegate**.
<img src={stepTwo} width={1440} />
you want to delegate your stake to, and then select **Delegate**.
<img src={stepTwo} width={1440} />

To learn more about a validator before making a decision,
open the details page by selecting the validator's name
from the list. For more ways to learn about a validator,
see [Track validators](./../manage/track-validators.mdx).
<img src={validatorDetails} width={1440} />
To learn more about a validator before making a decision,
open the details page by selecting the validator's name
from the list. For more ways to learn about a validator,
see [Track validators](./../manage/track-validators.mdx).
<img src={validatorDetails} width={1440} />

3. Enter the amount manually or choose **Max** to stake all available RON,
and then select **Delegate**. Expand the estimated annual rewards to
reveal your estimated monthly and daily earnings.
<img src={stepThree} width={400} />
<img src={stepThree} width={400} />

4. Confirm the transaction.
<img src={stepFour} width={400} />
<img src={stepFour} width={400} />

## View your delegations
## View your stake

To view the list of validators that you delegated to,
To view the list of validators that you staked to,
go to [RON staking](https://app.roninchain.com/staking) > **My staking**.

<img src={myStaking} width={1440} />

## See also

* [Claim rewards](./../manage/claim-rewards.mdx)
* [Increase, move, or remove your stake](./../manage/increase-withdraw-stake.mdx)
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ const sidebars = {
id: 'delegators/index',
},
items: [
// Become a delegator
// Stake RON
'delegators/onboarding/become-delegator',
{
type: 'category',
Expand Down