mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 07:12:27 +00:00
docs: make every sidebar label a capitalized noun
Six groups were verbs -- Manage, Ingest, Train, Operate, Secure, Deploy -- and now name the thing rather than the action. Four more were sentence case. The page labels that were verb phrases follow: Add Computed Column becomes Computed Columns, Refresh Column becomes Column Refresh, Configuring Storage becomes Configuration, and Explain becomes Query Plans, which is also more accurate now that the page covers analyze as well. SQL statement pages take the keyword -- SELECT, DDL, DML, REFRESH, SHOW, EXPLAIN -- because a statement name is a noun and lowercase Select and Show read as instructions. Concept pages there keep noun phrases: Joins, Window Functions, Subqueries, Operators. Two duplicate labels are resolved on the way. Reranking sat in Semantic Search labelled Overview despite being the only page on its subject, and the Enterprise client page sat in SQL Reference labelled SQL next to the reference Overview; it is Client Connection now. Title case leaves prepositions and articles lowercase, so Needle in a Haystack and Hybrid Search on BEIR are already correct and unchanged.
This commit is contained in:
+7
-7
@@ -142,7 +142,7 @@
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Get started",
|
||||
"group": "Getting Started",
|
||||
"pages": [
|
||||
"index",
|
||||
"quickstart",
|
||||
@@ -163,7 +163,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Manage",
|
||||
"group": "Management",
|
||||
"pages": [
|
||||
"management/index",
|
||||
"management/database",
|
||||
@@ -185,7 +185,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Ingest",
|
||||
"group": "Ingestion",
|
||||
"pages": [
|
||||
"ingestion/index",
|
||||
"ingestion/insert",
|
||||
@@ -207,7 +207,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Feature engineering",
|
||||
"group": "Feature Engineering",
|
||||
"pages": [
|
||||
"feature-engineering/index",
|
||||
"feature-engineering/data-evolution",
|
||||
@@ -217,7 +217,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Train",
|
||||
"group": "Training",
|
||||
"pages": [
|
||||
"training/why-lancedb",
|
||||
"training/index",
|
||||
@@ -225,7 +225,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Operate",
|
||||
"group": "Operations",
|
||||
"pages": [
|
||||
"indexing/reindexing",
|
||||
"maintenance/compaction",
|
||||
@@ -240,7 +240,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "SQL reference",
|
||||
"group": "SQL Reference",
|
||||
"pages": [
|
||||
"sql/index",
|
||||
"sql/data-types",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Frequently Asked Questions
|
||||
sidebarTitle: FAQ
|
||||
sidebarTitle: "Overview"
|
||||
description: "Common questions about LanceDB"
|
||||
icon: "question-circle"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Add a computed column"
|
||||
sidebarTitle: "Add Computed Column"
|
||||
sidebarTitle: "Computed Columns"
|
||||
description: "Declare a column from a SQL expression. Nothing is evaluated until you refresh it."
|
||||
icon: table-columns
|
||||
keywords: ["computed columns", "add_columns", "transforms", "schema"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Refresh a materialized view"
|
||||
sidebarTitle: "Refresh Materialized View"
|
||||
sidebarTitle: "Materialized View Refresh"
|
||||
description: "A lakehouse object: a table defined by a query over another table, kept current incrementally."
|
||||
icon: table
|
||||
keywords: ["materialized view", "create_materialized_view", "refresh", "incremental"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Refresh a column"
|
||||
sidebarTitle: "Refresh Column"
|
||||
sidebarTitle: "Column Refresh"
|
||||
description: "Fill the rows of a computed column that lack values — in process, or as a server-side job."
|
||||
icon: arrows-rotate
|
||||
keywords: ["refresh_column", "backfill", "job", "idempotent", "REFRESH COLUMN"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Full-Text Search (FTS) Index"
|
||||
sidebarTitle: "FTS index"
|
||||
sidebarTitle: "FTS Index"
|
||||
description: "Create and tune BM25-based full-text search indexes in LanceDB."
|
||||
icon: "book"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Merge insert"
|
||||
sidebarTitle: "Merge insert"
|
||||
sidebarTitle: "Merge Insert"
|
||||
description: "Reconcile incoming rows against a key: update what matches, insert what does not."
|
||||
icon: code-merge
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Functions"
|
||||
sidebarTitle: "Functions"
|
||||
sidebarTitle: "Function"
|
||||
description: "Register a Python function once and apply it as a column, for work SQL cannot express."
|
||||
icon: code
|
||||
keywords: ["udf", "functions", "create_function", "embedding", "feature engineering"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Reranking Search Results"
|
||||
sidebarTitle: "Overview"
|
||||
sidebarTitle: "Reranking"
|
||||
description: "Use a reranker to improve search relevance."
|
||||
icon: "sort-amount-down"
|
||||
keywords: ["re-ranking", "reranker", "rerank"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Explain a query plan"
|
||||
sidebarTitle: Explain
|
||||
sidebarTitle: "Query Plans"
|
||||
description: "Read the plan LanceDB resolved for a query, and measure it with analyze."
|
||||
icon: "map"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Hybrid Search
|
||||
sidebarTitle: Hybrid search
|
||||
sidebarTitle: "Hybrid Search"
|
||||
description: Learn how to perform hybrid search in LanceDB by combining vector and full-text search techniques with reranking.
|
||||
icon: "search"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Vector Search"
|
||||
sidebarTitle: Vector search
|
||||
sidebarTitle: "Vector Search"
|
||||
description: "Learn how to run vector search queries in LanceDB. Includes best practices, tips and examples."
|
||||
icon: "arrow-up-right-dots"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "EXPLAIN"
|
||||
sidebarTitle: "Explain"
|
||||
sidebarTitle: "EXPLAIN"
|
||||
description: "Reading the plan for a statement, and measuring it."
|
||||
icon: map
|
||||
keywords: ["explain", "explain analyze", "query plan", "describe"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Joins"
|
||||
sidebarTitle: "Join"
|
||||
sidebarTitle: "Joins"
|
||||
description: "Combining rows from more than one table, including across namespaces."
|
||||
icon: link
|
||||
keywords: ["join", "inner", "left", "outer", "cross", "namespace"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "REFRESH"
|
||||
sidebarTitle: "Refresh"
|
||||
sidebarTitle: "REFRESH"
|
||||
description: "Filling computed columns and bringing materialized views up to date."
|
||||
icon: arrows-rotate
|
||||
keywords: ["refresh column", "refresh materialized view", "backfill", "cascade"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "SELECT"
|
||||
sidebarTitle: "Select"
|
||||
sidebarTitle: "SELECT"
|
||||
description: "Projection, filtering, ordering, and composing queries out of other queries."
|
||||
icon: table-columns
|
||||
keywords: ["select", "where", "order by", "limit", "cte", "union", "distinct"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "SHOW"
|
||||
sidebarTitle: "Show"
|
||||
sidebarTitle: "SHOW"
|
||||
description: "Listing jobs, functions, materialized views, and the errors a job produced."
|
||||
icon: list
|
||||
keywords: ["show jobs", "show functions", "show materialized views", "show errors", "show tables"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Window functions"
|
||||
sidebarTitle: "Window"
|
||||
sidebarTitle: "Window Functions"
|
||||
description: "Compute over a set of rows related to the current one, without collapsing them."
|
||||
icon: chart-simple
|
||||
keywords: ["window", "over", "partition by", "row_number", "rank", "lag", "lead"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Configuring Cloud Storage in LanceDB"
|
||||
sidebarTitle: "Configuring storage"
|
||||
sidebarTitle: "Configuration"
|
||||
description: "Configure LanceDB to use S3, GCS, Azure Blob, and S3-compatible object stores with environment variables or storage options."
|
||||
icon: "wrench"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Storage Architecture in LanceDB"
|
||||
sidebarTitle: "Storage options"
|
||||
sidebarTitle: "Storage Options"
|
||||
description: "Understand LanceDB storage backends, tradeoffs, and how to pick the right option for your latency, scale, and cost goals."
|
||||
icon: "database"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Loading Data for Model Training"
|
||||
sidebarTitle: "Data loading and shuffles"
|
||||
sidebarTitle: "Data Loading & Shuffles"
|
||||
description: "Stream, shuffle, transform, and resume model training data from LanceDB."
|
||||
icon: boxes-stacked
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "PyTorch Integration"
|
||||
sidebarTitle: "PyTorch integration"
|
||||
sidebarTitle: "PyTorch"
|
||||
description: Learn how to use LanceDB with PyTorch for training and inference.
|
||||
icon: fire
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Why LanceDB for Training"
|
||||
sidebarTitle: "Why LanceDB for training"
|
||||
sidebarTitle: "Why LanceDB"
|
||||
description: "Use LanceDB as the multimodal data layer for model training, fine-tuning, curation, and feature engineering workflows."
|
||||
icon: fire
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Multimodal Agent"
|
||||
sidebarTitle: "Multimodal agent"
|
||||
sidebarTitle: "Multimodal Agent"
|
||||
description: "Build an AI agent that understands both text and images to help users find recipes using LanceDB and PydanticAI"
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user