feat: add Vale linter configuration and GitHub Action workflow #2102
Conversation
This file contains hidden or 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
- Add .vale.ini configuration with custom vocabulary and style settings - Set up GitHub Actions workflow for automated linting on PRs and pushes - Include custom vocabulary for DocsGPT-specific terms and technologies - Configure style rules for markdown files in the docs directory
|
@CBID2 is attempting to deploy a commit to the Arc53 Team on Vercel. A member of the Team first needs to authorize it. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2102 +/- ##
=======================================
Coverage 42.28% 42.28%
=======================================
Files 136 136
Lines 9315 9315
=======================================
Hits 3939 3939
Misses 5376 5376 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Christine Belzie <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
This pull request is adding Vale linter's GitHub Action.
Why was this change needed? (You can also link to an open issue here)
Adding this feature does the following for DocsGPT's documentation:
• Maintain Consistency: Enforce consistent terminology, tone, and formatting across all documentation
• Catch Errors Early: Identify spelling mistakes, grammar issues, and style violations during development
• Improve Contributor Experience: Provide immediate feedback to contributors about documentation standards
• Reduce Review Burden: Automate basic style checks, allowing maintainers to focus on content quality
• Align with Best Practices: Follow industry-standard documentation practices used by major open-source projects (GitLab, Kubernetes, Linode use Vale)
Closes #2099
I'm doing this for Hacktoberfest, and here's a screenshot of the output when I test it in the terminal: