From 135dfdc7eca99b8ce64e5c4fd279ba9bf217cf1e Mon Sep 17 00:00:00 2001 From: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Date: Thu, 20 Nov 2025 11:14:20 -0800 Subject: [PATCH] docs: 404 and outdated URLs should now work (#2800) Did a full scan of all URLs that used to point to the old mkdocs pages, and now links to the appropriate pages on lancedb.com/docs or lance.org docs. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/documentation.yml | 2 +- README.md | 2 +- docs/README.md | 4 ++-- docs/src/js/README.md | 2 +- docs/src/js/interfaces/ConnectionOptions.md | 2 +- docs/src/js/interfaces/CreateTableOptions.md | 2 +- docs/src/js/interfaces/OpenTableOptions.md | 2 +- nodejs/README.md | 2 +- nodejs/lancedb/connection.ts | 4 ++-- nodejs/src/lib.rs | 2 +- python/python/lancedb/__init__.py | 4 ++-- python/python/lancedb/common.py | 2 +- python/python/lancedb/db.py | 8 ++++---- python/python/lancedb/query.py | 4 ++-- python/python/lancedb/table.py | 2 +- rust/lancedb/src/connection.rs | 16 ++++++++-------- rust/lancedb/src/database/listing.rs | 6 +++--- rust/lancedb/src/lib.rs | 2 +- rust/lancedb/src/remote/db.rs | 2 +- 19 files changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 7fd4493e..da2929cf 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -18,6 +18,6 @@ body: label: Link description: > Provide a link to the existing documentation, if applicable. - placeholder: ex. https://lancedb.github.io/lancedb/guides/tables/... + placeholder: ex. https://lancedb.com/docs/tables/... validations: required: false diff --git a/README.md b/README.md index fc0a7360..5aac6528 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ # **The Multimodal AI Lakehouse** -[**How to Install** ](#how-to-install) ✦ [**Detailed Documentation**](https://lancedb.github.io/lancedb/) ✦ [**Tutorials and Recipes**](https://github.com/lancedb/vectordb-recipes/tree/main) ✦ [**Contributors**](#contributors) +[**How to Install** ](#how-to-install) ✦ [**Detailed Documentation**](https://lancedb.com/docs) ✦ [**Tutorials and Recipes**](https://github.com/lancedb/vectordb-recipes/tree/main) ✦ [**Contributors**](#contributors) **The ultimate multimodal data platform for AI/ML applications.** diff --git a/docs/README.md b/docs/README.md index 648e4e4e..fb656249 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ # LanceDB Documentation -LanceDB docs are deployed to https://lancedb.github.io/lancedb/. +LanceDB docs are available at [lancedb.com/docs](https://lancedb.com/docs). -Docs is built and deployed automatically by [Github Actions](../.github/workflows/docs.yml) +The SDK docs are built and deployed automatically by [Github Actions](../.github/workflows/docs.yml) whenever a commit is pushed to the `main` branch. So it is possible for the docs to show unreleased features. diff --git a/docs/src/js/README.md b/docs/src/js/README.md index 91f61526..1a00de46 100644 --- a/docs/src/js/README.md +++ b/docs/src/js/README.md @@ -34,7 +34,7 @@ const results = await table.vectorSearch([0.1, 0.3]).limit(20).toArray(); console.log(results); ``` -The [quickstart](https://lancedb.github.io/lancedb/basic/) contains a more complete example. +The [quickstart](https://lancedb.com/docs/quickstart/basic-usage/) contains a more complete example. ## Development diff --git a/docs/src/js/interfaces/ConnectionOptions.md b/docs/src/js/interfaces/ConnectionOptions.md index 14b05b24..f93c2170 100644 --- a/docs/src/js/interfaces/ConnectionOptions.md +++ b/docs/src/js/interfaces/ConnectionOptions.md @@ -89,4 +89,4 @@ optional storageOptions: Record; (For LanceDB OSS only): configuration for object storage. -The available options are described at https://lancedb.github.io/lancedb/guides/storage/ +The available options are described at https://lancedb.com/docs/storage/ diff --git a/docs/src/js/interfaces/CreateTableOptions.md b/docs/src/js/interfaces/CreateTableOptions.md index d69b98bb..91f582a5 100644 --- a/docs/src/js/interfaces/CreateTableOptions.md +++ b/docs/src/js/interfaces/CreateTableOptions.md @@ -97,4 +97,4 @@ Configuration for object storage. Options already set on the connection will be inherited by the table, but can be overridden here. -The available options are described at https://lancedb.github.io/lancedb/guides/storage/ +The available options are described at https://lancedb.com/docs/storage/ diff --git a/docs/src/js/interfaces/OpenTableOptions.md b/docs/src/js/interfaces/OpenTableOptions.md index 009549ec..6c67fde2 100644 --- a/docs/src/js/interfaces/OpenTableOptions.md +++ b/docs/src/js/interfaces/OpenTableOptions.md @@ -42,4 +42,4 @@ Configuration for object storage. Options already set on the connection will be inherited by the table, but can be overridden here. -The available options are described at https://lancedb.github.io/lancedb/guides/storage/ +The available options are described at https://lancedb.com/docs/storage/ diff --git a/nodejs/README.md b/nodejs/README.md index 15df64c0..327e630c 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -30,7 +30,7 @@ const results = await table.vectorSearch([0.1, 0.3]).limit(20).toArray(); console.log(results); ``` -The [quickstart](https://lancedb.github.io/lancedb/basic/) contains a more complete example. +The [quickstart](https://lancedb.com/docs/quickstart/basic-usage/) contains more complete examples. ## Development diff --git a/nodejs/lancedb/connection.ts b/nodejs/lancedb/connection.ts index 289694f2..8c234e29 100644 --- a/nodejs/lancedb/connection.ts +++ b/nodejs/lancedb/connection.ts @@ -42,7 +42,7 @@ export interface CreateTableOptions { * Options already set on the connection will be inherited by the table, * but can be overridden here. * - * The available options are described at https://lancedb.github.io/lancedb/guides/storage/ + * The available options are described at https://lancedb.com/docs/storage/ */ storageOptions?: Record; @@ -78,7 +78,7 @@ export interface OpenTableOptions { * Options already set on the connection will be inherited by the table, * but can be overridden here. * - * The available options are described at https://lancedb.github.io/lancedb/guides/storage/ + * The available options are described at https://lancedb.com/docs/storage/ */ storageOptions?: Record; /** diff --git a/nodejs/src/lib.rs b/nodejs/src/lib.rs index df1898e2..243562ec 100644 --- a/nodejs/src/lib.rs +++ b/nodejs/src/lib.rs @@ -35,7 +35,7 @@ pub struct ConnectionOptions { pub read_consistency_interval: Option, /// (For LanceDB OSS only): configuration for object storage. /// - /// The available options are described at https://lancedb.github.io/lancedb/guides/storage/ + /// The available options are described at https://lancedb.com/docs/storage/ pub storage_options: Option>, /// (For LanceDB OSS only): the session to use for this connection. Holds /// shared caches and other session-specific state. diff --git a/python/python/lancedb/__init__.py b/python/python/lancedb/__init__.py index ce1c1f4b..fc2613c5 100644 --- a/python/python/lancedb/__init__.py +++ b/python/python/lancedb/__init__.py @@ -72,7 +72,7 @@ def connect( default configuration is used. storage_options: dict, optional Additional options for the storage backend. See available options at - + session: Session, optional (For LanceDB OSS only) A session to use for this connection. Sessions allow you to configure @@ -174,7 +174,7 @@ async def connect_async( default configuration is used. storage_options: dict, optional Additional options for the storage backend. See available options at - + session: Session, optional (For LanceDB OSS only) A session to use for this connection. Sessions allow you to configure diff --git a/python/python/lancedb/common.py b/python/python/lancedb/common.py index 86670a15..c320f744 100644 --- a/python/python/lancedb/common.py +++ b/python/python/lancedb/common.py @@ -96,7 +96,7 @@ def data_to_reader( f"Unknown data type {type(data)}. " "Supported types: list of dicts, pandas DataFrame, polars DataFrame, " "pyarrow Table/RecordBatch, or Pydantic models. " - "See https://lancedb.github.io/lancedb/guides/tables/ for examples." + "See https://lancedb.com/docs/tables/ for examples." ) diff --git a/python/python/lancedb/db.py b/python/python/lancedb/db.py index 19953fa8..b58ab852 100644 --- a/python/python/lancedb/db.py +++ b/python/python/lancedb/db.py @@ -193,7 +193,7 @@ class DBConnection(EnforceOverrides): Additional options for the storage backend. Options already set on the connection will be inherited by the table, but can be overridden here. See available options at - + data_storage_version: optional, str, default "stable" Deprecated. Set `storage_options` when connecting to the database and set `new_table_data_storage_version` in the options. @@ -341,7 +341,7 @@ class DBConnection(EnforceOverrides): Additional options for the storage backend. Options already set on the connection will be inherited by the table, but can be overridden here. See available options at - + Returns ------- @@ -1077,7 +1077,7 @@ class AsyncConnection(object): Additional options for the storage backend. Options already set on the connection will be inherited by the table, but can be overridden here. See available options at - + Returns ------- @@ -1265,7 +1265,7 @@ class AsyncConnection(object): Additional options for the storage backend. Options already set on the connection will be inherited by the table, but can be overridden here. See available options at - + index_cache_size: int, default 256 **Deprecated**: Use session-level cache configuration instead. Create a Session with custom cache sizes and pass it to lancedb.connect(). diff --git a/python/python/lancedb/query.py b/python/python/lancedb/query.py index b6554de4..41db3b56 100644 --- a/python/python/lancedb/query.py +++ b/python/python/lancedb/query.py @@ -883,7 +883,7 @@ class LanceQueryBuilder(ABC): ---------- where: str The where clause which is a valid SQL where clause. See - `Lance filter pushdown `_ + `Lance filter pushdown `_ for valid SQL expressions. prefilter: bool, default True If True, apply the filter before vector search, otherwise the @@ -1356,7 +1356,7 @@ class LanceVectorQueryBuilder(LanceQueryBuilder): ---------- where: str The where clause which is a valid SQL where clause. See - `Lance filter pushdown `_ + `Lance filter pushdown `_ for valid SQL expressions. prefilter: bool, default True If True, apply the filter before vector search, otherwise the diff --git a/python/python/lancedb/table.py b/python/python/lancedb/table.py index 5db88a0d..333e3791 100644 --- a/python/python/lancedb/table.py +++ b/python/python/lancedb/table.py @@ -178,7 +178,7 @@ def _into_pyarrow_reader( f"Unknown data type {type(data)}. " "Supported types: list of dicts, pandas DataFrame, polars DataFrame, " "pyarrow Table/RecordBatch, or Pydantic models. " - "See https://lancedb.github.io/lancedb/guides/tables/ for examples." + "See https://lancedb.com/docs/tables/ for examples." ) diff --git a/rust/lancedb/src/connection.rs b/rust/lancedb/src/connection.rs index 3102099f..663d498e 100644 --- a/rust/lancedb/src/connection.rs +++ b/rust/lancedb/src/connection.rs @@ -239,7 +239,7 @@ impl CreateTableBuilder { /// Options already set on the connection will be inherited by the table, /// but can be overridden here. /// - /// See available options at + /// See available options at pub fn storage_option(mut self, key: impl Into, value: impl Into) -> Self { let store_options = self .request @@ -259,7 +259,7 @@ impl CreateTableBuilder { /// Options already set on the connection will be inherited by the table, /// but can be overridden here. /// - /// See available options at + /// See available options at pub fn storage_options( mut self, pairs: impl IntoIterator, impl Into)>, @@ -442,7 +442,7 @@ impl OpenTableBuilder { /// Options already set on the connection will be inherited by the table, /// but can be overridden here. /// - /// See available options at + /// See available options at pub fn storage_option(mut self, key: impl Into, value: impl Into) -> Self { let storage_options = self .request @@ -461,7 +461,7 @@ impl OpenTableBuilder { /// Options already set on the connection will be inherited by the table, /// but can be overridden here. /// - /// See available options at + /// See available options at pub fn storage_options( mut self, pairs: impl IntoIterator, impl Into)>, @@ -959,7 +959,7 @@ impl ConnectBuilder { /// Set an option for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_option(mut self, key: impl Into, value: impl Into) -> Self { self.request.options.insert(key.into(), value.into()); self @@ -967,7 +967,7 @@ impl ConnectBuilder { /// Set multiple options for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_options( mut self, pairs: impl IntoIterator, impl Into)>, @@ -1102,7 +1102,7 @@ impl ConnectNamespaceBuilder { /// Set an option for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_option(mut self, key: impl Into, value: impl Into) -> Self { self.storage_options.insert(key.into(), value.into()); self @@ -1110,7 +1110,7 @@ impl ConnectNamespaceBuilder { /// Set multiple options for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_options( mut self, pairs: impl IntoIterator, impl Into)>, diff --git a/rust/lancedb/src/database/listing.rs b/rust/lancedb/src/database/listing.rs index b30c021e..70568540 100644 --- a/rust/lancedb/src/database/listing.rs +++ b/rust/lancedb/src/database/listing.rs @@ -60,7 +60,7 @@ pub struct ListingDatabaseOptions { /// These are used to create/list tables and they are inherited by all tables /// opened by this database. /// - /// See available options at + /// See available options at pub storage_options: HashMap, } @@ -157,7 +157,7 @@ impl ListingDatabaseOptionsBuilder { /// Set an option for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_option(mut self, key: impl Into, value: impl Into) -> Self { self.options .storage_options @@ -167,7 +167,7 @@ impl ListingDatabaseOptionsBuilder { /// Set multiple options for the storage layer. /// - /// See available options at + /// See available options at pub fn storage_options( mut self, pairs: impl IntoIterator, impl Into)>, diff --git a/rust/lancedb/src/lib.rs b/rust/lancedb/src/lib.rs index 5d5272a2..b7e9cdf1 100644 --- a/rust/lancedb/src/lib.rs +++ b/rust/lancedb/src/lib.rs @@ -71,7 +71,7 @@ //! It treats [`FixedSizeList`](https://docs.rs/arrow/latest/arrow/array/struct.FixedSizeListArray.html) //! columns as vector columns. //! -//! For more details, please refer to [LanceDB documentation](https://lancedb.github.io/lancedb/). +//! For more details, please refer to the [LanceDB documentation](https://lancedb.com/docs). //! //! #### Create a table //! diff --git a/rust/lancedb/src/remote/db.rs b/rust/lancedb/src/remote/db.rs index 09c2c60d..ccf79b8a 100644 --- a/rust/lancedb/src/remote/db.rs +++ b/rust/lancedb/src/remote/db.rs @@ -90,7 +90,7 @@ pub struct RemoteDatabaseOptions { pub host_override: Option, /// Storage options configure the storage layer (e.g. S3, GCS, Azure, etc.) /// - /// See available options at + /// See available options at /// /// These options are only used for LanceDB Enterprise and only a subset of options /// are supported.