docs(repo): improve grammar and readability #18501
Merged
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
dantaik
changed the title
dantaik
approved these changes
Nov 22, 2024
RogerLamTd
approved these changes
Nov 22, 2024
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Taiko Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
davidtaikocha
approved these changes
Nov 22, 2024
This was referenced Nov 22, 2024
This was referenced Dec 27, 2024
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.
Reason: Using proper formal English instead of colloquial language in technical documentation
Reason: Fixed verb tense consistency in the sentence
Update README.md
Original informal text was updated to use proper grammar, capitalization and technical terminology:
The changes improve readability and professionalism by:
Adding proper capitalization at sentence starts
Using proper contractions (I'm)
Spelling out abbreviations (people instead of ppl, are instead of r)
Adding proper punctuation including question mark
Capitalizing technical terms (Verkle Trie, Merkle Tries)
These updates align with standard technical writing practices while maintaining the original meaning and making the documentation more accessible to all readers.