diff --git a/docs/apps/ron-staking.md b/docs/apps/ron-staking.md index 7351dee..9f981a1 100644 --- a/docs/apps/ron-staking.md +++ b/docs/apps/ron-staking.md @@ -10,7 +10,7 @@ RON Staking is an app where RON holders can delegate their tokens to validators, Key features: * [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/manage-stake.mdx): RON holders can increase or withdraw their stake from a validator, or move it to a different validator. +* [Manage your stake](./../delegators/manage/stake.mdx): RON holders can increase or withdraw their stake from a validator, or move it to a different validator. * [Claim or restake your rewards](./../delegators/manage/claim-rewards.mdx): RON holders can claim rewards for staking their tokens. Visit the staking app at [app.roninchain.com/staking](https://app.roninchain.com/staking). diff --git a/docs/basics/white-paper.md b/docs/basics/white-paper.md index 39233cd..daeab80 100644 --- a/docs/basics/white-paper.md +++ b/docs/basics/white-paper.md @@ -179,7 +179,7 @@ misses 100 more blocks on the same day, the following penalties apply: This time, the validator can't bail out. :::info Temporary maintenance mode -Validators can [schedule](./../validators/manage/schedule-maintenance.mdx) temporary maintenance, during which they don't get slashed for unavailability. +Validators can [schedule](./../validators/manage/maintenance.mdx) temporary maintenance, during which they don't get slashed for unavailability. ::: ### Unavailability bridge operator diff --git a/docs/delegators/delegator-faq.md b/docs/delegators/delegator-faq.md index 58c3c05..613beb0 100644 --- a/docs/delegators/delegator-faq.md +++ b/docs/delegators/delegator-faq.md @@ -13,7 +13,7 @@ You can manually [restake](./manage/claim-rewards.mdx#restake-your-rewards) the ## 3. Can I withdraw my stake whenever I want without any penalties? {#3} -You can [withdraw your stake](./manage/manage-stake.mdx#withdraw-stake) from one of your validators at any time without penalties, as long as it's been three or more days since you last staked with this validator. +You can [withdraw your stake](./manage/stake.mdx#withdraw-stake) from one of your validators at any time without penalties, as long as it's been three or more days since you last staked with this validator. ## 4. If I stake RON with a validator today, when will I receive the rewards? {#4} @@ -25,7 +25,7 @@ Your RON stake with new validator will start producing rewards from around 00:00 ## 6. How do I know if my validator is renouncing? {#6} -You will receive a notification seven days before the validator's renunciation date. For more ways to keep track of your validators, see [Track validators](./manage/track-validators.mdx). +You will receive a notification seven days before the validator's renunciation date. For more ways to keep track of your validators, see [Track validators](./manage/validators.mdx). ## 7. How can I know if a validator is well-performing? {#7} diff --git a/docs/delegators/index.mdx b/docs/delegators/index.mdx index 590e71e..89ce613 100644 --- a/docs/delegators/index.mdx +++ b/docs/delegators/index.mdx @@ -21,9 +21,9 @@ import {findSidebarItem} from '@site/src/sidebarUtils'; ## Manage your stake ## FAQ diff --git a/docs/delegators/manage/claim-rewards.mdx b/docs/delegators/manage/claim-rewards.mdx index 06bc04a..213fa9a 100644 --- a/docs/delegators/manage/claim-rewards.mdx +++ b/docs/delegators/manage/claim-rewards.mdx @@ -47,7 +47,7 @@ the next day. Instead of claiming the RON staking rewards to your Ronin Wallet, you can restake them to your favorite validator, which will increase your staking power. -1. In the **CLAIMABLE REWARDS** secttion, click **Restake**. +1. In the **CLAIMABLE REWARDS** section, click **Restake**. 2. Select the validator to whom you want to restake the RON, then click **Restake**. You can select an existing validator with whom you already stake, or choose a new validator. @@ -60,4 +60,4 @@ After the transaction is confirmed, you succefully restaked your RON rewards. ## See also -[Increase, withdraw, or move your stake](manage-stake.mdx) \ No newline at end of file +[Increase, withdraw, or move your stake](stake.mdx) \ No newline at end of file diff --git a/docs/delegators/manage/manage-stake.mdx b/docs/delegators/manage/stake.mdx similarity index 100% rename from docs/delegators/manage/manage-stake.mdx rename to docs/delegators/manage/stake.mdx diff --git a/docs/delegators/manage/track-validators.mdx b/docs/delegators/manage/validators.mdx similarity index 91% rename from docs/delegators/manage/track-validators.mdx rename to docs/delegators/manage/validators.mdx index e46b9b2..3560c56 100644 --- a/docs/delegators/manage/track-validators.mdx +++ b/docs/delegators/manage/validators.mdx @@ -1,6 +1,6 @@ --- -description: Keep track of updates among your validators. -title: Track your validators +description: Keep track of changes among the validators you staked with. +title: Keep track of validators --- import totalStakeStats from '../assets/total-stake-stats.png' diff --git a/docs/delegators/onboarding/become-delegator.mdx b/docs/delegators/onboarding/become-delegator.mdx index f63864d..c489ab2 100644 --- a/docs/delegators/onboarding/become-delegator.mdx +++ b/docs/delegators/onboarding/become-delegator.mdx @@ -56,4 +56,4 @@ This shows you how much RON you staked and with which validators. This is also w ## See also * [Claim or restake your staking rewards](./../manage/claim-rewards.mdx) -* [Increase, withdraw, or move your stake](./../manage/manage-stake.mdx) +* [Increase, withdraw, or move your stake](./../manage/stake.mdx) diff --git a/docs/get-started.mdx b/docs/get-started.mdx index c8d5692..54cdd03 100644 --- a/docs/get-started.mdx +++ b/docs/get-started.mdx @@ -42,9 +42,9 @@ Stake RON to earn staking rewards, claim or restake rewards, and more. diff --git a/docs/validators/index.mdx b/docs/validators/index.mdx index d01d21c..cf8d574 100644 --- a/docs/validators/index.mdx +++ b/docs/validators/index.mdx @@ -36,13 +36,14 @@ Take the steps to set up your validator account: ## Manage your account -2. Read through the terms and then click **Submit request**. +2. Agree to the terms and submit the request -3. After your request is submitted, provide evidence of the attack to the Governing Validators in the [#validator-chat](https://discord.com/channels/930892666705694800/1090764739858153553) channel on Ronin Discord. +3. Submit evidence of the attack to the Governing Validators in the [#validator-chat](https://discord.com/channels/930892666705694800/1090764739858153553) channel on Ronin Discord. ## Result -Based on the Governing Validators' vote on your Emergency Exit proposal, your stake may be refunded as follows: +Based on the Governing Validators' vote on your proposal, your stake may be refunded as follows: * If the proposal's approved, your entire self-stake is refunded: 50,000 RON is credited immediately, while the remaining amount is transferred to you the next day (00:00 UTC). * If the proposal's not approved or expires, you're refunded the amount equal to your self-stake minus 50,000 RON. The amount is transferred to you after seven working days from the proposal's creation date. -After your emergency exit is complete, you can no longer validate transactions on Ronin and receive rewards. Your status is set to "Renounced." +After the emergency exit is complete, you'll no longer be able to confirm blocks on Ronin and receive rewards. Your status will be set to "Renounced." diff --git a/docs/validators/manage/finality-vote-key.mdx b/docs/validators/manage/finality.mdx similarity index 100% rename from docs/validators/manage/finality-vote-key.mdx rename to docs/validators/manage/finality.mdx diff --git a/docs/validators/manage/maintenance-exit.mdx b/docs/validators/manage/maintenance-exit.mdx new file mode 100644 index 0000000..c0e01fa --- /dev/null +++ b/docs/validators/manage/maintenance-exit.mdx @@ -0,0 +1,15 @@ +--- +title: Early exit maintenance +description: Exit maintenance mode early or cancel planned maintenance. +--- + +import ongoingMaintenance from './assets/maintenance-ongoing.png'; +import upcomingMaintenance from './assets/maintenance-upcoming.png'; + +If you took your node offline for maintenance but found that you can get back to normal operation sooner than expected, you can exit maintenance mode early. Likewise, if there's no longer a need to take your node offline, you can cancel any planned maintenance. + +To exit maintenance mode early, open the [Validator Dashboard](https://validator.roninchain.com), then go to your account, and then click **Early Exit Maintenance**. You will resume block confirmation starting from the next epoch. + + +To cancel planned maintenance, click **Cancel Scheduled Maintenance**. + diff --git a/docs/validators/manage/schedule-maintenance.mdx b/docs/validators/manage/maintenance.mdx similarity index 51% rename from docs/validators/manage/schedule-maintenance.mdx rename to docs/validators/manage/maintenance.mdx index 2258052..afd547d 100644 --- a/docs/validators/manage/schedule-maintenance.mdx +++ b/docs/validators/manage/maintenance.mdx @@ -1,6 +1,6 @@ --- -title: Schedule maintenance period -description: Schedule a maintenance period for your validator node. +title: Schedule maintenance +description: Plan a maintenance period for your node. --- import stepOne from './assets/schedule-maintenance-step-1.png'; @@ -8,20 +8,16 @@ import stepTwo from './assets/schedule-maintenance-step-2.png'; import ongoingMaintenance from './assets/maintenance-ongoing.png'; import upcomingMaintenance from './assets/maintenance-upcoming.png'; -You can schedule when your node undergoes maintenance. -Maintenance can be scheduled by up to three validators at the same time. -If you are having trouble scheduling maintenance, ask the other validators about their maintenance schedules. -After your current maintenance ends, you need to wait at least three days before scheduling another one. +Sometimes, you need to take your node offline for maintenance. You can schedule a maintenance period in advance to let other users know when your node will be down. Because only up to three validators can schedule maintenance at the same time, you may need to align with the other validators to avoid schedule overlaps. After the maintenance ends, you'll need to wait at least three days before scheduling the next one. 1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Maintenance mode**. -2. Specify the maintenance duration in epochs. -The valid duration is 3-144 epochs (from about 30 minutes to 24 hours), where 1 epoch equals 200 blocks. +2. Specify the maintenance duration in epochs, where 1 epoch equals 200 blocks. You can choose from the valid start epoch, then decide on the end epoch. -3. After you submit the request, the system displays the status +3. After you submit the request, the system will display the status and duration of the maintenance period.

diff --git a/docs/validators/manage/renounce-role.mdx b/docs/validators/manage/renounce.mdx similarity index 80% rename from docs/validators/manage/renounce-role.mdx rename to docs/validators/manage/renounce.mdx index afb6fbd..9cd773f 100644 --- a/docs/validators/manage/renounce-role.mdx +++ b/docs/validators/manage/renounce.mdx @@ -1,13 +1,13 @@ --- -description: Renounce your validator role. -title: Renounce your role +description: Renounce your Ronin validator role. +title: Renounce validator role --- import renounceStepOne from './assets/renounce-step-1.png'; import renounceStepTwo from './assets/renounce-step-2.png'; If you're a Standard Validator or Validator Candidate, -follow this guide to renounce your validator role. If you’re a Governing Validator, contact Sky Mavis for instructions. +follow this guide to renounce your validator role. Governing Validators should reach out to Sky Mavis for further steps. 1. Open the [Validator Dashboard](https://validator.roninchain.com), then select your account, and then click **Renounce**. diff --git a/docs/validators/manage/increase-withdraw-stake.mdx b/docs/validators/manage/stake.mdx similarity index 100% rename from docs/validators/manage/increase-withdraw-stake.mdx rename to docs/validators/manage/stake.mdx diff --git a/docs/validators/manage/view-profile.mdx b/docs/validators/manage/view-profile.mdx index 2b90b57..88db8ca 100644 --- a/docs/validators/manage/view-profile.mdx +++ b/docs/validators/manage/view-profile.mdx @@ -19,14 +19,14 @@ your profile contains the following addresses: * **Admin address.** The address used to manage your profile and -staking activities, and to claim rewards. You can change this address. For more information, see [Change your admin address](address.mdx#admin). +staking activities, and to claim rewards. You can change this address. For more information, see [Change your admin address](addresses.mdx#admin). * **Validator address.** The address used for producing blocks. This address is displayed to delegators and also called “consensus address”. * **Bridge operator address.** The address used for operating [Ronin Bridge](https://bridge.roninchain.com/). * **Bridge governor address.** The address used to vote on changes to the bridge, such as pausing the bridge or adding bridge operators. -* **Finality vote key.** This is the [cryptographic key](finality-vote-key.mdx) used to vote -for blocks in the fast finality mechanism. You can change this key. For more information, see [Change your finality vote key](finality-vote-key.mdx#change). +* **Finality vote key.** This is the [cryptographic key](finality.mdx) used to vote +for blocks in the fast finality mechanism. You can change this key. For more information, see [Change your finality vote key](finality.mdx#change). If you’re a Governing Validator, your profile has an additional **Governing validator address,** used to [create proposals](./../governance/create-proposal.mdx) and diff --git a/docs/validators/onboarding/become-validator.mdx b/docs/validators/onboarding/become-validator.mdx index 94fd0f7..e39a943 100644 --- a/docs/validators/onboarding/become-validator.mdx +++ b/docs/validators/onboarding/become-validator.mdx @@ -1,6 +1,6 @@ --- -description: Register as a Validator Candidate. -title: Register as a validator +description: Register as a validator on Ronin. +title: Become a validator --- import becomeValidator from './assets/become-validator.png'; @@ -56,7 +56,7 @@ It's also highly recommended that you read the 5. Provide the initial stake of RON. -6. Enter your fast finality vote key—see [Add or change finality vote key](../manage/finality-vote-key.mdx) for details. +6. Enter your fast finality vote key—see [Add or change finality vote key](../manage/finality.mdx) for details. Congratulations, you're now a Validator Candidate. diff --git a/sidebars.js b/sidebars.js index 4a9c41b..883f7fa 100644 --- a/sidebars.js +++ b/sidebars.js @@ -160,11 +160,11 @@ const sidebars = { // Stake RON 'delegators/onboarding/become-delegator', // Manage your stake - 'delegators/manage/manage-stake', + 'delegators/manage/stake', // Claim or restake your rewards 'delegators/manage/claim-rewards', // Track your validators - 'delegators/manage/track-validators', + 'delegators/manage/validators', // FAQ 'delegators/delegator-faq', ], @@ -262,28 +262,30 @@ const sidebars = { slug: '/validators/manage', }, items: [ - // Add or change finality vote key - 'validators/manage/finality-vote-key', - // Change commission rate - 'validators/manage/change-commission', - // Change admin address - 'validators/manage/address', - // Claim rewards - 'validators/manage/claim-rewards', - // Increase or move stake - 'validators/manage/increase-withdraw-stake', - // Renounce role - 'validators/manage/renounce-role', - // Schedule maintenance period - 'validators/manage/schedule-maintenance', - // Take emergency exit - 'validators/manage/take-emergency-exit', // View activity 'validators/manage/view-activity', // View analytics 'validators/manage/view-analytics', - // View profile - 'validators/manage/view-profile', + // View profile details + 'validators/manage/view-profile', + // Claim rewards + 'validators/manage/claim-rewards', + // Increase or move stake + 'validators/manage/stake', + // Add or change finality vote key + 'validators/manage/finality', + // Change commission rate + 'validators/manage/commission', + // Change admin address + 'validators/manage/addresses', + // Schedule maintenance + 'validators/manage/maintenance', + // Early exit maintenance + 'validators/manage/maintenance-exit', + // Renounce validator role + 'validators/manage/renounce', + // Request emergency exit + 'validators/manage/emergency-exit', ], }, // Slashing