Repository navigation
feat: add a shared Vale style package for documentation prose - #376
Merged
Merged
Conversation
Add STYLE.md, a short guide to names, punctuation, headings and wording, and vale/LanceDB, a Vale package that checks its mechanical rules: product names, em dashes and their substitutes, repeated words, and two vague phrasings. lancedb/lancedb and lancedb/sophon pin the package by release; this repository lints its own pages with the working copy and skips the generated dataset pages. The Prose style workflow tests the rules and annotates only the lines a pull request changes, without failing.
Style findings never fail the check, but a failure to install Vale, sync the package or read its configuration still fails the job.
Archiving a directory uses the current time for every entry, so two builds of the same commit differ. Set --mtime to the commit time.
This was referenced Oct 18, 2026
brendanclement
marked this pull request as ready for review
October 19, 2026 17:15
rpgreen
approved these changes
Oct 19, 2026
rpgreen
left a comment
rpgreen
left a comment
Contributor
There was a problem hiding this comment.
Cool! Does it pass on the existing repo?
Contributor
Author
its advisory, so it does pass. it had a bunch of suggestions that I have a pending local PR to address |
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
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.
lancedb/lancedb and lancedb/sophon publish pages from
docs/web, but nothing checks the mechanical rules of the LanceDB writing style, so reviewers keep catching the same naming and punctuation mistakes by hand.Change.
STYLE.md, a practical guide to page purpose, examples, tradeoffs, clear wording and formatting, linked fromWRITING.md.vale/LanceDB, a small Vale package: product names, em dashes and their substitutes, vague headings and phrases, plain-language suggestions, plusVale.Repetition. Each rule has test cases.