Detect typos in Markdown documents (2nd attempt) #9347
Merged
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.
Problem
Typos and grammar errors are not easy to detect, specially when documentation is created with standard editors. This becomes harder for non-native English speakers.
Change overview
This change fixes some of the current existing typos in the markdown documents as well as provides a set of GitHub actions for reviewing new changes and/or additions in documents.
Testing
The GitHub actions will only be triggered when changes on markdown are detected.