-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Detect typos in Markdown documents (2nd attempt) #9347
Merged
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
boring-cyborg
bot
added
documentation
Improvements or additions to documentation
examples
github
linux
platform
scripts
workflows
zephyr
labels
Aug 30, 2021
electrocucaracha
force-pushed
the
fix_typos
branch
from
August 30, 2021 23:18
a3468c4
to
a6497aa
Compare
jmeg-sfy
approved these changes
Aug 31, 2021
woody-apple
approved these changes
Aug 31, 2021
chrisdecenzo
approved these changes
Sep 1, 2021
jelderton
approved these changes
Sep 2, 2021
electrocucaracha
force-pushed
the
fix_typos
branch
2 times, most recently
from
September 7, 2021 19:19
b9191c0
to
840a37f
Compare
@electrocucaracha This doesn't pass restyled, looks like it's struggling with the .github workflow, and the wordlist. How did we seed this wordlist with things like |
Signed-off-by: Victor Morales <v.morales@samsung.com>
Signed-off-by: Victor Morales <v.morales@samsung.com>
electrocucaracha
force-pushed
the
fix_typos
branch
from
September 8, 2021 02:26
840a37f
to
22811dd
Compare
pullapprove
bot
requested review from
andy31415,
Damian-Nordic,
jepenven-silabs,
msandstedt and
vivien-apple
September 8, 2021 02:27
Size increase report for "esp32-example-build" from 6c9042e
Full report output
|
msandstedt
approved these changes
Sep 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
examples
github
linux
platform
review - approved
scripts
workflows
zephyr
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.