TaylorandBrendan Clement
9e65bd2c27
Use “LanceDB Enterprise” throughout the staged website guides, SDK reference sources, generated API pages, and user-facing SDK messages. A separate branded “LanceDB Distributed” name adds terminology without clarifying behavior; describe where operations run directly. - Update `docs/web`, including the architecture diagram title and alt text. Use Enterprise in headings, table labels, and prose; simplify redundant product/execution-model wording and name the product only once in the diagram alt text. - Update Python docstrings and the Python/Java reference pages, TypeScript comments and native declaration comments, and Rust API documentation. Regenerate the TypeScript reference, including 24 replacements across six pages. - Update SDK warnings/errors and existing test expectations to match, along with contributor guidance and Vale rules. Remove the obsolete rule distinguishing Enterprise from Distributed. - Keep lowercase “distributed” for technical descriptions. API identifiers, anchors, asset paths, and execution behavior are unchanged. No branded-name exceptions are proposed. Validation: - Python and Node native builds succeeded; focused Python tests passed (36 passed, 4 skipped), and focused Node tests passed (14). - TypeDoc generation and the complete MkDocs reference build passed. MkDocs retains an existing unresolved `lancedb.functions.SecretReference` cross-reference. - Rust formatting, Node lint/format, changed-file Python lint/format, 32 Vale tests, and whitespace checks passed. Repository-wide Python lint has 48 existing findings in six untouched files. - Combined documentation assembly passed. Mintlify validation and link/anchor/redirect checks previously passed for both site builds; no code snippets changed. Companion PRs: [saved editions, terminology guide, and shared rules](https://github.com/lancedb/docs/pull/413), [Enterprise overview and writing rules](https://github.com/lancedb/sophon/pull/9511). --------- Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
1.3 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" 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.