Fix Typos in Documentation Files #139
Open
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
The word "Addtionally" is misspelled; the correct spelling is "Additionally."
The word "available" should be replaced with "availability":
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.
Description:
This pull request addresses two spelling errors found in the documentation files, which could lead to minor misunderstandings or a lack of polish in the project’s presentation.
Files and Corrections:
File:
docs/src/faq.mdTypo: "Addtionally, most validator clients will log a message containing the url."
Correction: "Additionally, most validator clients will log a message containing the URL."
Reason: The word "Addtionally" was misspelled. Correcting it to "Additionally" improves readability and maintains professional quality.
File:
docs/src/about.mdTypo: "We have received a pDAO grant to help ensure its ongoing available to the community."
Correction: "We have received a pDAO grant to help ensure its ongoing availability to the community."
Reason: The word "available" should be "availability" to ensure proper grammar and clarity in meaning.
Importance of These Corrections:
Correct spelling and grammar are critical for maintaining a professional tone in documentation, which reflects on the project’s overall credibility. Accurate language ensures that users understand the material without distraction, especially in technical contexts where clarity is essential. By fixing these typos, we improve the documentation's quality and the user experience.