Files
lancedb/.github/vale
Jack YeandClaude Sonnet 5 de95ed3f6d docs: overhaul curation, feature engineering, security and deployment guides (#4748)
A broad documentation pass across the areas LanceDB Enterprise and
Embedded
diverge on most:

**Data Curation** -- GPU Function execution, Slurm scheduling (and what
Slurm is, for readers new to it), blob late materialization as its own
page, joins, aggregation/profiling, sampling, near-duplicate detection,
chunking, distributed shuffle, and IVF-partition clustering.

**Feature Engineering** -- computed columns and materialized views,
restructured to lead with the Function-based path and show the SQL form
side by side with Python throughout; a single Auto Refresh page instead
of
duplicating scheduling details on every refresh page; adaptive
execution;
checkpointing; GPU and Slurm placement for refresh workers; a Training
Cache page for the PyTorch data loader's automatic cache benefit.

**Security & Governance** -- an Audit Log reference (schema, access,
grants), Secrets promoted to an ordinary catalog object with their own
SQL
DDL and a vending/rotation guide, and privilege-table fixes verified
against the authorization source.

**Deployment & Maintenance** -- Horizontal Scaling and OpenTelemetry
moved
into a real Deployment area; Automated Cleanup folded into Intelligent
Auto-Maintenance (every other maintenance decision already lived there);
RTE Compaction and Advanced Conflict Resolution documented in depth.

**Landing page** -- the Enterprise feature comparison table reorganized
(several redundant or stale rows removed, several new areas added), and
the
"why Enterprise" bullets replaced with ones tied to a concrete page
(Performance, Scale, Fault tolerance, Multicloud deployment, Simplify
operations) instead of vague promises.

Plus a full pass addressing lancedb-gatekeeper's review: a real
test-safety
bug (a quickstart test could silently overwrite and delete a
deployment's
own `frames` table), a fabricated SQL statement with no backing
implementation, an actual dedup-guarantee bug in `take_row_ids`, and
dozens
of documentation-accuracy fixes verified against source rather than
taken
on faith -- each either fixed, or left with an explicit note on why it
needs a feature or deployment owner's sign-off instead of being guessed
at.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_018PXMCbRH6i5w47TsjeEUMT

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-11-03 16:17:24 -08:00
..

LanceDB prose rules

Dashes, PlainLanguage, ProductNames, VagueHeadings and VaguePhrases come from the LanceDB.zip asset of lancedb/docs release vale-lancedb-v0.1.0, whose archive SHA-256 is 0730a43e919774121068811d5687c61dfc7a0421cff78e1393f5e565b622cb0f. ProductNames no longer swaps in "LanceDB OSS" and now recommends "LanceDB Enterprise" for the retired "LanceDB Distributed" name.

The product-terminology rules were added here: EmbeddedName, RemoteExecution, OSSProduct, InternalNames (warnings) and LegacyCloud (suggestion). They enforce the names in the docs repository's STYLE.md#names. Run every rule's tests from .github/vale with vale test --coverage styles.

Keeping the rules here lets contributors and CI run Vale without access to the source repository. The root .vale.ini preserves the release's MDX settings and built-in repeated-word check. No vale sync is needed.

The rules check product names, dashes, plain language, vague headings and vague phrases. Findings are suggestions and do not fail the CI check.

To update, a maintainer downloads the next published package, verifies its checksum and replaces styles/LanceDB with the release's files. Check the package's .vale.ini for configuration changes, and update the version and checksum here in the same PR.