Enabling Vale CI with GitHub Actions #871
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
costrouc
approved these changes
Oct 18, 2021
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
Fixes #863
This PR enables Vale linter for the official documentation. It will check every PR for typos, grammar issues and make suggestions for the same.
As of now, the Vale style has been adopted with a custom vocabulary to suit out needs. It can be further refined over the time with the addition of custom styles, error messages as per our documentation needs.
The PR also fixes miscellaneous issues with the existing documentation to ensure that we can use Vale on a much more consistent basis now (without creating a lot of noise).
Local Test
brew install valeon macOS)docs/)