Install and configure Vale with Google Developer style guide rules #1621
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
sg-writer
added
kind/enhancement
sg-writer
force-pushed
the
sg/doc-428-set-up-vale-in-mintlify
branch
from
fa03f37 to
db76b41
Compare
sg-writer
force-pushed
the
sg/doc-428-set-up-vale-in-mintlify
branch
from
d551ff6 to
44923be
Compare
S3Prototype
reviewed
Oct 3, 2025
| "verify-redirects": "node snippets/custom-scripts/check-redirect-conflicts.js", | ||
| "test-links": "mint broken-links" | ||
| "test-links": "mint broken-links", | ||
| "vale": "vale --glob='!{snippets,errors}/**' ." |
There was a problem hiding this comment.
Is it possible to add vale to the dependencies? When I try to run this command I get the error that vale is not installed
Also, we should mention this command in the readme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
this PR installs Vale with (most of) the Google style rules package to get us started. I made some changes throughout to make it more useful to us but there's definitely more to be done. This should be enough to start using Vale right away as a CI check.
I tried getting an LLM to fix the 500ish errors reported but it made a colossal mess so I had to revert all of those changes. We can start to actually apply the Vale rules in follow-up PRs.
The command to run it is
pnpm run vale. There are lots of flags available to refine it.Note: once this PR is merged we'll need to turn Vale back on in the Mintlify dashboard to get the CI checks.