Skip to content

Mega Typo Pr and Similar Improvements #1176

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 5 commits into
base: master
Choose a base branch
from
Open

Conversation

themacexpert
Copy link
Contributor

Description

Why fix one typo when you can try to fix them allllll?

This pull request includes various corrections and improvements to documentation files across multiple Ethereum development tools and libraries. The changes primarily focus on fixing typos, improving clarity, and updating examples to ensure accuracy and consistency.

Documentation Corrections and Improvements:

Typographical Fixes:

  • Corrected "it's" to "its" in the Waffle Mars deployment instructions. (builders/ethereum/dev-env/waffle-mars.md)
  • Fixed "succesful" to "successful" in transaction result descriptions for Ethers.js, Ethers.rs, and Web3.py libraries. (builders/ethereum/libraries/ethersjs.md, builders/ethereum/libraries/ethersrs.md, builders/ethereum/libraries/web3py.md) [1] [2] [3]
  • Corrected "excution" to "execution" in the Ethers.rs library guide. (builders/ethereum/libraries/ethersrs.md)

Content Clarifications:

  • Updated the description of Web3.py to clarify interaction with Moonbeam nodes. (builders/ethereum/libraries/web3py.md)
  • Improved phrasing for deployment steps in the Remix tutorial. (builders/ethereum/json-rpc/pubsub.md)
  • Enhanced clarity in the explanation of the notePreimage function in the Preimage Precompile guide. (builders/ethereum/precompiles/features/governance/preimage.md)

Example Updates:

  • Replaced "tokenSupply" with "totalSupply" in the Remix tutorial to match standard ERC-20 terminology. (builders/ethereum/dev-env/remix.md)
  • Corrected the function name from "placeDecisionDeposit" to "refundDecisionDeposit" in the Referenda Precompile guide. (builders/ethereum/precompiles/features/governance/referenda.md)

Image and Formatting Adjustments:

  • Fixed captions for images in Preimage and Staking Precompile guides to improve readability. (builders/ethereum/precompiles/features/governance/preimage.md, builders/ethereum/precompiles/features/staking.md) [1] [2]

These changes collectively enhance the accuracy, usability, and professionalism of the documentation, ensuring a better experience for developers working with Ethereum tools and libraries.

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 00:12
@themacexpert themacexpert requested a review from a team as a code owner July 8, 2025 00:12
@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 20:24
Copilot

This comment was marked as outdated.

@themacexpert themacexpert requested a review from Copilot July 8, 2025 22:12
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 fixes typos, improves phrasing, and updates terminology and examples across multiple documentation files to enhance accuracy and readability.

  • Corrected spelling and punctuation errors (e.g., “succesful” → “successful”, “its” vs. “it's”)
  • Clarified descriptions and headings (e.g., updated Web3.py node reference, fixed anchor IDs)
  • Standardized example terminology (e.g., tokenSupplytotalSupply, placeDecisionDepositrefundDecisionDeposit)

Reviewed Changes

Copilot reviewed 46 out of 49 changed files in this pull request and generated no comments.

Show a summary per file
File Description
llms-full.txt Various typo and heading‐ID fixes
learn/core-concepts/security.md Fixed “it's” → “its”
builders/ethereum/dev-env/remix.md Updated ERC-20 example from tokenSupplytotalSupply
builders/integrations/analytics/dapplooker.md Punctuation fixes and comma additions
builders/substrate/libraries/sidecar.md Corrected “created” → “create” in directory note
builders/ethereum/precompiles/utility/registry.md Aligned registry address to Moonbase Alpha
Comments suppressed due to low confidence (2)

builders/integrations/analytics/dapplooker.md:12

  • [nitpick] Consider rephrasing to “using an easy-to-use editor” to improve readability and apply hyphenation for the compound adjective.
Dapplooker analytics platform complements Moonbeam-based networks by helping users make sense of smart contracts without having to rely on an engineer or analyst. Dapplooker’s intuitive Visual SQL helps browse smart contract data in tabular form and write SQL queries using easy to use editor. Users can create, fork, and share dashboards with everyone.

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