Repository navigation
Make Vale lint the docs - #264
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Three faults stopped it. StylesPath pointed at a styles/ directory that did not exist, so Vale aborted with E201 before reading a page. The rule section matched src/content/**, a path from the Astro site. And the workflow's changed-files filter matched that same dead path, so the linter step was skipped by its own `if:` and the job passed having checked nothing. Adds styles/Fly and the fly-terms vocabulary, which are ours and cannot be fetched. The three public packages stay gitignored and are now pinned by release URL, so `vale sync` cannot pull a version that starts enforcing rules nobody has looked at. Fly.Spelling stays off until the vocabulary covers these pages.
kcmartin
force-pushed
the
vale-lint-mdx
branch
from
October 9, 2026 21:10
6ececae to
3f0997b
Compare
This branch was successfully deployed
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.
Vale has never linted anything in this repo. Three separate faults:
StylesPath = stylespointed at a directory that does not exist, so Vale aborted withE201before reading a page[src/content/**/*.{mdx,md}], a path from the Astro siteif:and the job reported success having checked nothingSo every "Vale linter pass" here, including on #261 and #262, meant nothing.
This adds
styles/Flyand thefly-termsvocabulary, 12 files that are ours and that Vale cannot fetch. The three public packages stay gitignored and keep being fetched byvale sync, but they are now pinned by release URL rather than trackinglatest.Packagesaccepts URLs, just notname@version.The pinning matters. On
latest, the current Google package enforcesGoogle.WordListCase,Google.Timeless,Google.AnthropomorphismandGoogle.ExcessiveClaims, none of whichsuperfly/docshas, which took this repo from 1 alert to 50. Pinned, a package bump becomes a reviewable one-line change instead of appearing overnight.The pins reproduce what docs currently enforces: I checked v0.6.3, v0.3.4 and v0.4.1 against all 532 handwritten pages in that repo and got exactly the same 101 alerts in the same 74 files as its committed copy. Worth knowing separately that docs' copy is a 2023 snapshot nobody chose, so these pins are also three years old, and moving them forward is its own decision.
Fly.Spellingis off for now. It flags 41 terms and all of them are legitimate, such asHerdr,zsh,worktreeandsystemd. Tracked with the docs half in https://github.com/superfly/docs-tracking/issues/359With this, the repo reports exactly one alert:
open-sourceshould beopen sourceinintegrations/platform-integrations.mdx. Left for a content PR.Companion to superfly/docs#2544