Will JonesandClaude Opus 5.5
4d7a64712f
## Summary Adopts the product terminology guide across the docs site pages, SDK docstrings and error messages. "LanceDB OSS" and local mode become **LanceDB Embedded**. "Remote" as the execution model becomes **LanceDB Distributed**, which LanceDB Enterprise provides. Where free vs paid is the point, pages contrast "LanceDB Embedded (open source)" with "LanceDB Enterprise". This is a first trial of the Embedded name, so reviewers can judge it in context. - **Embedded vs Distributed** for where execution runs (`optimize()`, consistency, branching, maintenance). Main pages define it once: "LanceDB Enterprise runs LanceDB Distributed: …" - **LanceDB Cloud** is kept only for legacy-Cloud specifics (`db://` region, the brute-force KNN limit) and marked legacy. "Cloud and Enterprise" becomes Enterprise or Distributed. - **Plan executor** becomes "executor" or the fleet name. - **Error messages** change, e.g. `optimize is not supported for remote tables.` → `... in LanceDB Distributed.` Tests that match on them are updated. - **Vale rules** (`EmbeddedName`, `OSSProduct`, `RemoteExecution`, `DistributedEnterprise`, `LegacyCloud`, `InternalNames`) enforce the terms in prose. Unchanged: identifiers (`availability.oss`, the `remote` module and feature, `RemoteTable`, `db://`), heading anchors, internal code comments, and Geneva. ## Evidence - Rust lib tests for the changed messages and the Python tests in `test_remote_db.py`, `test_materialized_views.py` and `test_table.py` pass locally. - Not run locally: - The Node tests: `remote.test.ts` and `table.test.ts` have updated assertions. - Vale. - The `experimental_functions`-marked materialized-view tests. - `docs/src` API reference was hand-edited to match the docstrings rather than regenerated. ## Merge Risk **Door:** two-way; prose and message text only. **Blast Radius:** `docs`, `error-messages`: callers matching on old error strings would break. Companion PRs: lancedb/docs (assembler labels, STYLE.md) and sophon (Enterprise pages). 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1.2 KiB
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".
The product-terminology rules were added here: EmbeddedName,
RemoteExecution, OSSProduct, DistributedEnterprise, 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.