fix: add Vale linting [DM-4] #442
Open
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
darrickyong
changed the title
mikemimik
requested changes
Jan 7, 2026
Contributor
mikemimik
left a comment
mikemimik
left a comment
There was a problem hiding this comment.
🤔 The output of the vale action is a little different than I expected. I thought that it would be similar to the terminal output you showed me @darrickyong when implementing this. My expectation was that the action would fail, not pass, and I'm curious why that is.
nlucero
reviewed
Jan 8, 2026
hazel-nut
reviewed
Jan 12, 2026
Contributor
hazel-nut
left a comment
hazel-nut
left a comment
There was a problem hiding this comment.
let's move the vale config back to the a4aa directory while it's only applying to a4aa docs. the github action is handy! have you looked into using reviewdog to leave inline PR comments?
Comment on lines
+20
to
+24
| - uses: errata-ai/[email protected] | ||
| with: | ||
| files: '["auth4genai/"]' | ||
| fail_on_error: true | ||
| filter_mode: nofilter |
Contributor
There was a problem hiding this comment.
can we set this to run only on the files that are changed in the PR?
Comment on lines
+113
to
+116
| ## Vale Linting | ||
|
|
||
| We use [Vale](https://vale.sh/) to keep terminology and brand usage consistent across the docs. See the dedicated Vale guide in [`./.vale/README.md`](./.vale/README.md) for details on configuration structure, MDX support, and how to extend or adjust the rules. | ||
|
|
Contributor
There was a problem hiding this comment.
let's remove this from here + restore it in the a4aa README
| # Vale Linting | ||
|
|
||
| This directory contains the Vale configuration used to lint and standardize the documentation in `auth4genai`. Vale helps ensure consistent terminology, brand usage, spelling, and overall prose quality. | ||
| This directory contains the Vale configuration used to lint and standardize the documentation in `docs-v2`. Vale helps ensure consistent terminology, brand usage, spelling, and overall prose quality. |
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.
By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.
Description
This PR adds
valeas a Github Action and initialvaleconfig.References
Testing
Checklist