-
Notifications
You must be signed in to change notification settings - Fork 98
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this 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.,
tokenSupply
→totalSupply
,placeDecisionDeposit
→refundDecisionDeposit
)
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 tokenSupply → totalSupply |
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.
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:
builders/ethereum/dev-env/waffle-mars.md
)builders/ethereum/libraries/ethersjs.md
,builders/ethereum/libraries/ethersrs.md
,builders/ethereum/libraries/web3py.md
) [1] [2] [3]builders/ethereum/libraries/ethersrs.md
)Content Clarifications:
builders/ethereum/libraries/web3py.md
)builders/ethereum/json-rpc/pubsub.md
)notePreimage
function in the Preimage Precompile guide. (builders/ethereum/precompiles/features/governance/preimage.md
)Example Updates:
builders/ethereum/dev-env/remix.md
)builders/ethereum/precompiles/features/governance/referenda.md
)Image and Formatting Adjustments:
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
moonbeam-docs-cn
repo, I have created a ticket for the translations in Jiramoonbeam-mkdocs
to update redirectsmove-pages.py
script to move the pages and update the image paths on the chinese repomoonbeam-docs-cn
compress-images.py
script to compress the images.moonbeam-docs-cn
repo to use the new variablesCorresponding PRs
Please link to any corresponding PRs here.
After Translation Requirements
moonbeam-docs
repo to remove imagesmoonbeam-docs
repo to remove variablesmoonbeam-mkdocs
repo to add redirects for Chinese siteItems to be Updated
Please list any of the items that will need to be added or deleted after the translations are done here.