Jack YeandClaude Sonnet 5
b32afe9794
## Summary - Adds a new top-level "Introduction" nav section before "Getting Started": LanceDB, LanceDB Embedded, LanceDB Enterprise, Embedded vs Enterprise. - Trims the landing page's combined Architecture/Embedded/Enterprise/Compare block down to a short pointer section (keeping its `#architecture` anchor), moving that content into two new pages: `basics/lancedb-embedded.mdx` and `basics/embedded-vs-enterprise.mdx`. - `basics/embedded-vs-enterprise.mdx` consolidates the feature-comparison table and the Enterprise overview's own comparison content (previously duplicated across multiple pages and, within this page, repeated across a dimension table, several narrative subsections, and a usage-differences list) into one comparison page with each section covering a distinct angle. - Repoints the `/enterprise` and `/enterprise/deployment` redirects at `/basics/embedded-vs-enterprise`, since the previous destination only resolves once the Enterprise overlay is applied and fails `rust/lancedb/src/docs.rs`'s link-resolution test against this repo's own `docs/web` tree. ## Companion change lancedb/sophon#9718 trims the Enterprise overview page to drop the content that moved here, and relocates its nav insertion into the new Introduction group. Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
LanceDB Documentation
For website guides in docs/web, start with
Documentation in CONTRIBUTING.md. That
covers editing pages, generated examples, previews, availability and drafts.
This page covers the SDK reference in docs/src, built with MkDocs. Its
GitHub Actions workflow builds and deploys on
pushes to main, so it can include unreleased APIs. That is separate from the
release editions of the Mintlify website.
Building the docs
Setup
- Install LanceDB Python. See setup in Python contributing guide.
Run
make developto install the Python package. - Install documentation dependencies. From LanceDB repo root:
pip install -r docs/requirements.txt
Preview the docs
Run these commands from the LanceDB repository root. The subshell changes into
docs to load mkdocs.yml, while leaving your shell in the repository root.
(cd docs && PYTHONPATH=. mkdocs serve)
If you want to just generate the HTML files:
(cd docs && PYTHONPATH=. mkdocs build)
If successful, you should see a docs/site directory in the repository root that
you can verify locally.
Adding examples
To make sure examples are correct, we put examples in test files so they can be run as part of our test suites.
You can see the tests are at:
- Python:
python/python/tests/docs - Typescript:
nodejs/examples/
Checking python examples
cd python
pytest -vv python/tests/docs
Checking typescript examples
The examples depend on @lancedb/lancedb at file:../dist, so the package must be
built before running the tests. This uses pnpm; see the
Typescript contributing guide for the toolchain setup.
pushd nodejs
pnpm install
pnpm build
popd
Then you can run the examples by going to the nodejs/examples directory, which is a
separate pnpm package with its own lockfile:
pushd nodejs/examples
pnpm install
pnpm test
popd
API documentation
Python
The Python API documentation is organized based on the file docs/src/python/python.md.
We manually add entries there so we can control the organization of the reference page.
However, this means any new types must be manually added to the file. No additional
steps are needed to generate the API documentation.
Typescript
The typescript API documentation is generated from the typescript source code using typedoc.
When new APIs are added, you must manually re-run the typedoc command to update the API documentation. The new files should be checked into the repository.
pushd nodejs
# `pnpm docs` would invoke pnpm's built-in `docs` command, not the script.
pnpm run docs
popd