lancedb/.vale.ini at 4ea45f55eeff4261df741e167cfe87912135cd48 - lancedb - Gitea: Git with a cup of tea

rust/lancedb

mirror of https://github.com/lancedb/lancedb.git synced 2026-10-23 12:12:27 +00:00

Files

T

Brendan Clement 52eed381bb ci: add an advisory Vale check for documentation prose (#4581 )

Checks `docs/web` against the shared LanceDB style rules, so the same
mechanical mistakes reach review.

**Change.**

- Add `.vale.ini`, pinning the shared LanceDB Vale package by release
(`vale-lancedb-v0.1.0`), and ignore the synced `.vale/` directory.
- Add the Docs prose style workflow. On pull requests that change
`docs/web` pages or `.vale.ini`, it annotates only added or changed
lines and never fails on a style finding; an install, sync or
configuration error still fails it.
- Link the style guide from `CONTRIBUTING.md` and show how to check a
page locally.


Validation: Tested in [temporary PR
#4595](https://github.com/lancedb/lancedb/pull/4595). Vale flagged all
five deliberate style issues on the changed prose lines, left inline
code and unchanged lines alone, and kept the check green. [Passing
workflow
run](https://github.com/lancedb/lancedb/actions/runs/39299187786/job/118219554825).

2026-10-19 12:47:25 -07:00

6 lines

329 B

INI

Raw Blame History

 # Prose style for the pages in docs/web: the shared LanceDB package, pinned by
 # release. The rules and guide live in lancedb/docs (STYLE.md and vale/).
 # Run `vale sync` once, then `vale docs/web/<page>.mdx`.
 StylesPath = .vale/styles
 Packages = https://github.com/lancedb/docs/releases/download/vale-lancedb-v0.1.0/LanceDB.zip