Fix typos and consistency issues in documentation #958
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.md
Fixed typo in "Bug Bounty" reference:
Before: Lido Bug Bounry (/bugbounty.md)
After: Lido Bug Bounty (/bugbounty.md)
Reason: "Bounry" is a typo, the correct spelling is "Bounty".
2. docs/scratch-deploy.md
Fixed incorrect wording in installation instruction:
Before: Run yarn install (get sure repo dependencies are installed)
After: Run yarn install (make sure repo dependencies are installed)
Reason: "get sure" is grammatically incorrect; "make sure" is the correct phrase.
Standardized testnet name "Holesky":
Before: Holešky Testnet Deployment
After: Holesky Testnet Deployment
Reason: The correct testnet name is "Holesky" (without the special character "š"), which matches Ethereum's official naming.
3. docs/upgrade-deploy.md
Fixed incorrect placeholder spelling:
Before: DEPLOYER=
After: DEPLOYER=
Before: RPC_URL=
After: RPC_URL=
Reason: "YOU" was incorrect; "YOUR" is the correct word in this context.
Fixed typo in "required values" reference:
Before: specifying require values under .
After: specifying required values under .
Reason: "require" is incorrect in this context; "required" is the grammatically correct word.