From 734eb39dc378686cbe85797a69c41f6b51d7b9b2 Mon Sep 17 00:00:00 2001 From: Jack Ye Date: Mon, 14 Sep 2026 01:16:43 -0700 Subject: [PATCH] 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. --- docs/web/docs.json | 14 +++++++------- docs/web/faq/index.mdx | 2 +- .../feature-engineering/add-computed-column.mdx | 2 +- .../web/feature-engineering/materialized-views.mdx | 2 +- docs/web/feature-engineering/refresh-column.mdx | 2 +- docs/web/indexing/fts-index.mdx | 2 +- docs/web/ingestion/merge-insert.mdx | 2 +- docs/web/management/function.mdx | 2 +- docs/web/reranking/index.mdx | 2 +- docs/web/search/explain.mdx | 2 +- docs/web/search/hybrid-search.mdx | 2 +- docs/web/search/vector-search.mdx | 2 +- docs/web/sql/explain.mdx | 2 +- docs/web/sql/join.mdx | 2 +- docs/web/sql/refresh.mdx | 2 +- docs/web/sql/select.mdx | 2 +- docs/web/sql/show.mdx | 2 +- docs/web/sql/window.mdx | 2 +- docs/web/storage/configuration.mdx | 2 +- docs/web/storage/index.mdx | 2 +- docs/web/training/index.mdx | 2 +- docs/web/training/torch.mdx | 2 +- docs/web/training/why-lancedb.mdx | 2 +- .../tutorials/agents/multimodal-agent/index.mdx | 2 +- 24 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/web/docs.json b/docs/web/docs.json index 421c59b6c..25c7133ca 100644 --- a/docs/web/docs.json +++ b/docs/web/docs.json @@ -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", diff --git a/docs/web/faq/index.mdx b/docs/web/faq/index.mdx index c4bc36a71..7d2370c75 100644 --- a/docs/web/faq/index.mdx +++ b/docs/web/faq/index.mdx @@ -1,6 +1,6 @@ --- title: Frequently Asked Questions -sidebarTitle: FAQ +sidebarTitle: "Overview" description: "Common questions about LanceDB" icon: "question-circle" --- diff --git a/docs/web/feature-engineering/add-computed-column.mdx b/docs/web/feature-engineering/add-computed-column.mdx index 3f4c4a260..4cadc4953 100644 --- a/docs/web/feature-engineering/add-computed-column.mdx +++ b/docs/web/feature-engineering/add-computed-column.mdx @@ -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"] diff --git a/docs/web/feature-engineering/materialized-views.mdx b/docs/web/feature-engineering/materialized-views.mdx index 982760539..034eaa028 100644 --- a/docs/web/feature-engineering/materialized-views.mdx +++ b/docs/web/feature-engineering/materialized-views.mdx @@ -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"] diff --git a/docs/web/feature-engineering/refresh-column.mdx b/docs/web/feature-engineering/refresh-column.mdx index 23ca5ef95..db1480811 100644 --- a/docs/web/feature-engineering/refresh-column.mdx +++ b/docs/web/feature-engineering/refresh-column.mdx @@ -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"] diff --git a/docs/web/indexing/fts-index.mdx b/docs/web/indexing/fts-index.mdx index 2d62ad893..4e18d5a86 100644 --- a/docs/web/indexing/fts-index.mdx +++ b/docs/web/indexing/fts-index.mdx @@ -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" --- diff --git a/docs/web/ingestion/merge-insert.mdx b/docs/web/ingestion/merge-insert.mdx index a2c2cd7e1..9e0cc52d9 100644 --- a/docs/web/ingestion/merge-insert.mdx +++ b/docs/web/ingestion/merge-insert.mdx @@ -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 --- diff --git a/docs/web/management/function.mdx b/docs/web/management/function.mdx index b7e166610..b47e43e82 100644 --- a/docs/web/management/function.mdx +++ b/docs/web/management/function.mdx @@ -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"] diff --git a/docs/web/reranking/index.mdx b/docs/web/reranking/index.mdx index fd9a9dea4..e17b43552 100644 --- a/docs/web/reranking/index.mdx +++ b/docs/web/reranking/index.mdx @@ -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"] diff --git a/docs/web/search/explain.mdx b/docs/web/search/explain.mdx index 838990d7c..f99b976e7 100644 --- a/docs/web/search/explain.mdx +++ b/docs/web/search/explain.mdx @@ -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" --- diff --git a/docs/web/search/hybrid-search.mdx b/docs/web/search/hybrid-search.mdx index 76ea5d34f..4a2d2dead 100644 --- a/docs/web/search/hybrid-search.mdx +++ b/docs/web/search/hybrid-search.mdx @@ -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" --- diff --git a/docs/web/search/vector-search.mdx b/docs/web/search/vector-search.mdx index 6d1104b84..42efbf7bf 100644 --- a/docs/web/search/vector-search.mdx +++ b/docs/web/search/vector-search.mdx @@ -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" --- diff --git a/docs/web/sql/explain.mdx b/docs/web/sql/explain.mdx index 2e4b613b1..efbae49e1 100644 --- a/docs/web/sql/explain.mdx +++ b/docs/web/sql/explain.mdx @@ -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"] diff --git a/docs/web/sql/join.mdx b/docs/web/sql/join.mdx index 4b4c5bc86..29a69cf0b 100644 --- a/docs/web/sql/join.mdx +++ b/docs/web/sql/join.mdx @@ -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"] diff --git a/docs/web/sql/refresh.mdx b/docs/web/sql/refresh.mdx index 3208261eb..1cff471da 100644 --- a/docs/web/sql/refresh.mdx +++ b/docs/web/sql/refresh.mdx @@ -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"] diff --git a/docs/web/sql/select.mdx b/docs/web/sql/select.mdx index 03bd0c71b..ae9e8ba4e 100644 --- a/docs/web/sql/select.mdx +++ b/docs/web/sql/select.mdx @@ -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"] diff --git a/docs/web/sql/show.mdx b/docs/web/sql/show.mdx index bdecf6107..4356581b3 100644 --- a/docs/web/sql/show.mdx +++ b/docs/web/sql/show.mdx @@ -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"] diff --git a/docs/web/sql/window.mdx b/docs/web/sql/window.mdx index d0bb1b895..91e58ea95 100644 --- a/docs/web/sql/window.mdx +++ b/docs/web/sql/window.mdx @@ -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"] diff --git a/docs/web/storage/configuration.mdx b/docs/web/storage/configuration.mdx index 45d8beccf..1d9074ca9 100644 --- a/docs/web/storage/configuration.mdx +++ b/docs/web/storage/configuration.mdx @@ -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" --- diff --git a/docs/web/storage/index.mdx b/docs/web/storage/index.mdx index 1d57dceee..c3ad7c452 100644 --- a/docs/web/storage/index.mdx +++ b/docs/web/storage/index.mdx @@ -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" --- diff --git a/docs/web/training/index.mdx b/docs/web/training/index.mdx index a1510a2f8..c2ddecc91 100644 --- a/docs/web/training/index.mdx +++ b/docs/web/training/index.mdx @@ -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 --- diff --git a/docs/web/training/torch.mdx b/docs/web/training/torch.mdx index 3877c67d6..d94702ebc 100644 --- a/docs/web/training/torch.mdx +++ b/docs/web/training/torch.mdx @@ -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 --- diff --git a/docs/web/training/why-lancedb.mdx b/docs/web/training/why-lancedb.mdx index a74b0ee88..27fc58dd1 100644 --- a/docs/web/training/why-lancedb.mdx +++ b/docs/web/training/why-lancedb.mdx @@ -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 --- diff --git a/docs/web/tutorials/agents/multimodal-agent/index.mdx b/docs/web/tutorials/agents/multimodal-agent/index.mdx index 039f01c5b..7c0e4ecaf 100644 --- a/docs/web/tutorials/agents/multimodal-agent/index.mdx +++ b/docs/web/tutorials/agents/multimodal-agent/index.mdx @@ -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" ---