Skip to content

Make Vale lint the docs - #264

Merged
kcmartin merged 1 commit into
mainfrom
vale-lint-mdx
Oct 9, 2026
Merged

kcmartin merged 1 commit into
mainfrom
vale-lint-mdx

Conversation

@kcmartin

@kcmartin kcmartin commented Oct 9, 2026 •

Copy link
Copy Markdown
Collaborator

Vale has never linted anything in this repo. Three separate faults:

  • StylesPath = styles pointed at a directory that does not exist, so Vale aborted with E201 before reading a page
  • the rule section was [src/content/**/*.{mdx,md}], a path from the Astro site
  • the workflow's changed-files filter was that same dead path, so the linter step was skipped by its own if: and the job reported success having checked nothing

So every "Vale linter pass" here, including on #261 and #262, meant nothing.

This adds styles/Fly and the fly-terms vocabulary, 12 files that are ours and that Vale cannot fetch. The three public packages stay gitignored and keep being fetched by vale sync, but they are now pinned by release URL rather than tracking latest. Packages accepts URLs, just not name@version.

The pinning matters. On latest, the current Google package enforces Google.WordListCase, Google.Timeless, Google.Anthropomorphism and Google.ExcessiveClaims, none of which superfly/docs has, 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.Spelling is off for now. It flags 41 terms and all of them are legitimate, such as Herdr, zsh, worktree and systemd. Tracked with the docs half in https://github.com/superfly/docs-tracking/issues/359

With this, the repo reports exactly one alert: open-source should be open source in integrations/platform-integrations.mdx. Left for a content PR.

Companion to superfly/docs#2544

@mintlify

mintlify Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
fly-io 🟢 Ready View Preview Oct 9, 2026, 9:12 PM

💡 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
kcmartin merged commit 449c291 into main Oct 9, 2026
1 check passed
@kcmartin
kcmartin deleted the vale-lint-mdx branch October 9, 2026 21:36

This branch was successfully deployed

1 active deployment
staging — 3f0997b1 Deployed Oct 9, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant