Skip to content

Narrow Vale to Fly's word list and doubled words - #2595

Merged
kcmartin merged 2 commits into
mainfrom
vale-narrow
Oct 22, 2026
Merged

kcmartin merged 2 commits into
mainfrom
vale-narrow

Conversation

@kcmartin

Copy link
Copy Markdown
Contributor

Narrows the Vale check to the two things worth having: Fly's house word list and doubled words.

What changes

  • Only Fly's own style and Vale's built-ins. The Google, proselint and write-good packages are gone, along with the Packages pins and about 55 lines of rules that were already switched off.
  • On: Fly.WordList and Vale.Repetition. Vale.Repetition is set to warning, since by default a doubled word shows as a red annotation. Vale.Avoid is off: its one reject-list entry, healthcheck, is already in the word list, so it would flag the same word twice.
  • Three word list entries removed, because following them makes the docs worse:
    • free tier: all 4 hits are pages correctly saying there is no free tier, and the suggested "free allowances" doesn't exist for new orgs either.
    • k8s: all 4 hits are literal commands like fly ext k8s create, or the k8s.io URL.
    • data are: the one hit, "healthcare apps and data are", is correct.
  • flyctl/cmd/ and api/machines/models.mdx are excluded. They're generated in other repos, and now that the file list works, every flyctl release PR would otherwise get suggestions nobody can act on here.
  • The workflow pins Vale to 3.24.0, so a release can't change behavior without a PR, and skips vale sync, since there's nothing left to download.

Spelling stays off for good, so https://github.com/superfly/docs-tracking/issues/359 can close as not planned.

On main this takes the findings from 112 to 66. Nothing about how the check behaves changes: it looks only at the files a PR changes, never blocks a merge, and isn't a required check.

How this PR tests itself. The second commit fixes a real "a a" typo and one in order to in two blueprints. That leaves exactly three findings in blueprints/shared-nothing.mdx, so CI should show 3 annotations, at lines 282, 302 and 440, and nothing else. A green check alone can't tell "found nothing" from "ran nothing".

@mintlify

mintlify Bot commented Oct 22, 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 22, 2026, 6:13 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@kcmartin

Copy link
Copy Markdown
Contributor Author

Matched the prediction: https://github.com/superfly/docs/actions/runs/39829330722

  • 3 annotations, on blueprints/shared-nothing.mdx lines 282, 302 and 440, and none on staging-prod-isolation.mdx now its typo is fixed.
  • Ran Vale 3.24.0, and vale sync was never invoked.
  • No errors and no fallback to linting the whole repo.

@kcmartin
kcmartin merged commit 31c8f6a into main Oct 22, 2026
2 checks passed
@kcmartin
kcmartin deleted the vale-narrow branch October 22, 2026 18:16

This branch was successfully deployed

1 active deployment
staging — fb1ae038 Deployed Oct 22, 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