Skip to content

Mega Typo PR 2 #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Mega Typo PR 2 #1177

wants to merge 9 commits into from

Conversation

themacexpert
Copy link
Contributor

Description

Mega Typo PR 2 - split up into two to make it easier to review.

This pull request includes various improvements to the documentation for Moonbeam's features, focusing on grammar corrections, clarity enhancements, and consistency in phrasing. The changes span multiple topics, including governance, staking, randomness, treasury, and Ethereum compatibility.

Governance Documentation Enhancements:

  • Improved phrasing for governance principles, replacing "ahead of any personal gain" with "above personal gain" for clarity and consistency. (learn/features/governance.md)
  • Updated phrasing in the description of voting processes to clarify delayed enactment, changing "such that people that disagree" to "so that people who disagree." (learn/features/governance.md)
  • Corrected phrasing for the Whitelisted track description, changing "getting dispatched" to "being dispatched." (learn/features/governance.md)

Staking Documentation Refinements:

  • Enhanced clarity in the explanation of collator rewards, specifying "until all rewards have been paid out" instead of "until all of the rewards have been paid." (learn/features/staking.md)
  • Improved phrasing for delegation rewards, changing "the collators you delegate" to "the collators you delegate to." (learn/features/staking.md)

Randomness Documentation Updates:

  • Refined explanation of VRF randomness, replacing "random values were generated by the submitter" with "they were generated by the submitter" for conciseness. (learn/features/randomness.md)
  • Clarified the description of epoch randomness, changing "the next collator can fulfill it" to "the next eligible collator can fulfill the request." (learn/features/randomness.md)

Treasury Documentation Improvements:

  • Simplified phrasing in the description of Treasury funding, changing "Treasury spend proposers must draft and submit their proposals" to "Treasury spend proposers must submit their proposals." (learn/features/treasury.md)

Ethereum Compatibility Documentation Adjustments:

  • Enhanced readability by replacing "developers can leverage their knowledge" with "developers can leverage their existing knowledge." (learn/features/eth-compatibility.md)
  • Corrected grammatical errors, such as changing "without modifications" to "without modification." (learn/features/eth-compatibility.md)

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@Copilot Copilot AI review requested due to automatic review settings July 8, 2025 22:10
@themacexpert themacexpert requested a review from a team as a code owner July 8, 2025 22:10
@themacexpert themacexpert added A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B0 - Needs Review Pull request is ready for review labels Jul 8, 2025
Copilot

This comment was marked as outdated.

@themacexpert themacexpert requested a review from Copilot July 8, 2025 22:12
Copilot

This comment was marked as outdated.

@themacexpert themacexpert requested a review from Copilot July 8, 2025 22:23
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refines documentation across tutorials and guides by fixing typos, improving phrasing, and ensuring consistency in terminology.

  • Corrected grammar, spelling, and punctuation in various tutorials and reference docs
  • Standardized naming (e.g., “crossChainPropose”, “interoperability”) and command paths
  • Enhanced clarity in headings and instructions

Reviewed Changes

Copilot reviewed 36 out of 38 changed files in this pull request and generated no comments.

File Description
tutorials/interoperability/remote-staking-xcm.md Updated relay-chain naming for consistency
tokens/connect/coinbase-wallet.md Adjusted phrasing for account retrieval instructions
node-operators/networks/collators/faq.md Fixed typo in product name and article misuse in FAQ
tokens/connect/mathwallet.md Improved announcement wording for readability
Comments suppressed due to low confidence (4)

tokens/connect/coinbase-wallet.md:103

  • [nitpick] The phrase 'provides you with on Moonbeam' is awkward. Consider rephrasing to '...provides on Moonbeam' or '...provides you with an Ethereum-compatible account on Moonbeam'.
 2. Tap on the QR code icon or the copy icon next to **Ethereum address**. Since Moonbeam is Ethereum-compatible, you can use the Ethereum account it provides you with on Moonbeam

node-operators/networks/collators/faq.md:12

  • [nitpick] Remove the article 'an' before 'attention to detail' for grammatical correctness: '...careful monitoring, and attention to detail.'
Running a Moonbeam collator requires Linux systems administration skills, careful monitoring, and an attention to detail. Below are some tips and tricks that have been accumulated which should help you get up and running quickly.

tutorials/interoperability/remote-staking-xcm.md:83

  • Verify that 'Moonbase relay chain' is the intended term—elsewhere it's referred to as 'Alphanet' or 'Moonbase Alpha'.
In this section, we'll be using the [Polkadot.js API](/builders/substrate/libraries/polkadot-js-api/){target=\_blank} to construct and send XCM instructions via the `send` extrinsic of the XCM Pallet on the Moonbase relay chain. The XCM message will transport our remote execution instructions to the Moonbase Alpha parachain to ultimately stake our desired amount of DEV tokens to a chosen collator.

tokens/connect/mathwallet.md:10

  • [nitpick] Consider a more direct verb form: 'MathWallet announced that it now natively supports each of the Moonbeam-based networks.'
MathWallet [announced](https://mathwallet.org/moonbeam-wallet/en) that it is now natively supporting each of the [Moonbeam-based networks](/learn/platform/networks/){target=\_blank}. This means that you are now able to interact with any of the networks using another wallet besides MetaMask.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B0 - Needs Review Pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant