Add Vale prose linter for documentation quality via Trunk#3822
Open
elviskahoro wants to merge 1 commit intodlt-hub:develfrom
Open
Add Vale prose linter for documentation quality via Trunk#3822elviskahoro wants to merge 1 commit intodlt-hub:develfrom
elviskahoro wants to merge 1 commit intodlt-hub:develfrom
Conversation
- Add .trunk/trunk.yaml with Vale v3.14.1 linter configured for docs/ - Add .trunk/configs/.vale.ini with markdown linting rules - Add .trunk/.gitignore to exclude trunk-generated files
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
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
Part of the Docs as a product initiative. This PR introduces Vale to enforce consistent writing style and terminology across our documentation β a gap called out explicitly in our docs strategy.
Why Vale
Inconsistent terminology and style drift across docs contributed by different teams (product, DevRel, SolEng) erodes user trust, hurts SEO, and causes AI coding assistants to produce unreliable output. Vale is the industry standard prose linter used by GitLab, Spotify, and Linode to solve exactly this problem β configurable, CI-friendly, and extensible with custom vocabulary rules.
Why Trunk as the runner
Rather than adding Vale as a standalone tool with its own config, CI step, and install process, this PR uses Trunk as a managed wrapper.
trunk checkinvocation runs everything without sequential scripts or glue code.trunk checkcommand. See this config for an example of a multi-linter setup..vale.ini, style rules) is fully portable. If we later decide against Trunk, we keep all the Vale work and just change how we invoke it.Scope
docs/**β zero impact on source code.trunk-fmt-pre-commitis disabled to preserve existing ruff/black workflows.Changes
.trunk/trunk.yamlβ Trunk CLI config (v1.25.0) with Vale v3.14.1, scoped todocs/**only.trunk/configs/.vale.iniβ Vale style config with markdoc format support.trunk/.gitignoreβ excludes Trunk build artifacts and user-local config from version controlNext steps
dltcasing, product names, API terms)