Improve titles and order of Features (#449)

lukekim · web-flow · commit 68a652844325 · 2024-10-08T10:31:49.000+09:00
* Clarify Arrow engine usage

* Tweak title and order of Features in sidebar
diff --git a/spiceaidocs/docs/features/ai-gateway/default_overrides.md b/spiceaidocs/docs/features/ai-gateway/default_overrides.md
diff --git a/spiceaidocs/docs/features/ai-gateway/index.md b/spiceaidocs/docs/features/ai-gateway/index.md
@@ -0,0 +1,25 @@
+---
+title: 'AI Gateway - Configuring LLMs'
+sidebar_label: 'AI Gateway'
+description: 'Learn how to configure language models and use Spice as an AI Gateway.'
+sidebar_position: 5
+pagination_prev: null
+pagination_next: null
+---
+
+Spice provides a high-performance, OpenAI API-compatible AI Gateway optimized for managing and scaling large language models (LLMs).
+
+Additionally, Spice offers tools for Enterprise Retrieval-Augmented Generation (RAG), such as SQL query across federated datasets and an advanced search feature (see [Search](/features/search)).
+
+Spice also supports **full OpenTelemetry observability**, enabling detailed tracking of data flows and requests for full transparency and easier debugging.
+
+## Configuring Language Models
+
+Spice supports a variety of LLMs (see [Model Components](/components/models/index.md)).
+
+### Core Features
+
+- **Custom Tools**: Equip models with tools to interact with the Spice runtime.
+- **System Prompts**: Customize system prompts and override defaults for [`v1/chat/completion`](/api/http/chat-completions.md).
+
+For detailed configuration and API usage, refer to the [API Documentation](/api).
diff --git a/spiceaidocs/docs/features/ai-gateway/runtime_tools.md b/spiceaidocs/docs/features/ai-gateway/runtime_tools.md
diff --git a/spiceaidocs/docs/features/caching/index.md b/spiceaidocs/docs/features/caching/index.md
@@ -2,7 +2,7 @@
 title: 'Results Caching'
 sidebar_label: 'Results Caching'
 description: 'Learn how to use Spice in-memory caching of query results'
-sidebar_position: 5
+sidebar_position: 3
 pagination_prev: null
 pagination_next: null
 ---
diff --git a/spiceaidocs/docs/features/cdc/index.md b/spiceaidocs/docs/features/cdc/index.md
@@ -2,12 +2,12 @@
 title: 'Change Data Capture (CDC)'
 sidebar_label: 'Change Data Capture'
 description: 'Learn how to use Change Data Capture (CDC) in Spice.'
-sidebar_position: 6
+sidebar_position: 4
 pagination_prev: null
 pagination_next: null
 ---
 
-Change Data Capture (CDC) is a technique to capture changed rows from a database's transaction log and deliver to consumers with low latency. Leveraging this technique allows Spice to keep [locally accelerated](../local-acceleration/index.md) datasets up-to-date in real-time with the source data, and is highly efficient by only transferring the changed rows instead of re-fetching the entire dataset on refresh.
+Change Data Capture (CDC) is a technique to capture changed rows from a database's transaction log and deliver to consumers with low latency. Leveraging this technique allows Spice to keep [locally accelerated](../data-acceleration/index.md) datasets up-to-date in real-time with the source data, and is highly efficient by only transferring the changed rows instead of re-fetching the entire dataset on refresh.
 
 ## Benefits
 
diff --git a/spiceaidocs/docs/features/configurable-llms/index.md b/spiceaidocs/docs/features/configurable-llms/index.md
diff --git a/spiceaidocs/docs/features/data-acceleration/constraints.md b/spiceaidocs/docs/features/data-acceleration/constraints.md
diff --git a/spiceaidocs/docs/features/data-acceleration/index.md b/spiceaidocs/docs/features/data-acceleration/index.md
@@ -1,8 +1,8 @@
 ---
-title: 'Local Acceleration'
-sidebar_label: 'Local Acceleration'
-description: 'Learn how to use local acceleration in Spice.'
-sidebar_position: 3
+title: 'Data Acceleration'
+sidebar_label: 'Data Acceleration'
+description: 'Learn how to use local data acceleration in Spice.'
+sidebar_position: 2
 pagination_prev: null
 ---
 
diff --git a/spiceaidocs/docs/features/data-acceleration/indexes.md b/spiceaidocs/docs/features/data-acceleration/indexes.md
diff --git a/spiceaidocs/docs/features/data-ingestion/index.md b/spiceaidocs/docs/features/data-ingestion/index.md
@@ -2,12 +2,11 @@
 title: 'Data Ingestion'
 sidebar_label: 'Data Ingestion'
 description: 'Learn how to ingest data in Spice.'
-sidebar_position: 4
+sidebar_position: 7
 pagination_prev: null
 pagination_next: null
 ---
 
-
 Data can be ingested by the Spice runtime for replication to a Data Connector, like PostgreSQL or the Spice.ai Cloud platform.
 
 By default, the runtime exposes an [OpenTelemety](https://opentelemetry.io) (OTEL) endpoint at grpc://127.0.0.1:50052 for data ingestion.
@@ -63,4 +62,4 @@ SMART data will be available in the `smart_attribute_raw_value` dataset in Spice
 
 - Only Spice.ai replication is supported for now.
 
-:::
+:::
diff --git a/spiceaidocs/docs/features/federated-queries/index.md b/spiceaidocs/docs/features/federated-queries/index.md
@@ -2,7 +2,7 @@
 title: 'Federated Queries'
 sidebar_label: 'Federated Queries'
 description: 'Learn how to use federated queries in Spice.'
-sidebar_position: 2
+sidebar_position: 1
 pagination_prev: null
 pagination_next: null
 ---
diff --git a/spiceaidocs/docs/features/search/index.md b/spiceaidocs/docs/features/search/index.md
@@ -2,7 +2,7 @@
 title: 'Search Functionality'
 sidebar_label: 'Search'
 description: 'Learn how Spice can search across datasets using database-native and vector-search methods.'
-sidebar_position: 8
+sidebar_position: 6
 pagination_prev: null
 pagination_next: null
 ---
diff --git a/spiceaidocs/docs/reference/spicepod/datasets.md b/spiceaidocs/docs/reference/spicepod/datasets.md
@@ -132,6 +132,7 @@ Required to enable a retention policy on the dataset.
 ## `time_format`
 
 Optional. The format of the `time_column`. The following values are supported:
+
 - `timestamp` - Default. Timestamp without a timezone. E.g. `2016-06-22 19:10:25` with data type `timestamp`.
 - `timestamptz` - Timestamp with a timezone. E.g. `2016-06-22 19:10:25-07` with data type `timestamptz`.
 - `unix_seconds` - Unix timestamp in seconds. E.g. `1718756687`.
@@ -269,7 +270,7 @@ The `indexes` field is a map where the key is the column reference and the value
 
 A column reference can be a single column name or a multicolumn key. The column reference must be enclosed in parentheses if it is a multicolumn key.
 
-See [Indexes](../../features/local-acceleration/indexes.md)
+See [Indexes](../../features/data-acceleration/indexes.md)
 
 ```yaml
 datasets:
@@ -289,7 +290,7 @@ Optional. Specify the primary key constraint on the locally accelerated table. N
 
 The `primary_key` field is a string that represents the column reference that should be used as the primary key. The column reference can be a single column name or a multicolumn key. The column reference must be enclosed in parentheses if it is a multicolumn key.
 
-See [Constraints](../../features/local-acceleration/constraints.md)
+See [Constraints](../../features/data-acceleration/constraints.md)
 
 ```yaml
 datasets:
@@ -316,7 +317,7 @@ The possible conflict resolution strategies are:
 - `upsert` - Upsert the incoming data when the primary key constraint is violated.
 - `drop` - Drop the data when the primary key constraint is violated.
 
-See [Constraints](../../features/local-acceleration/constraints.md)
+See [Constraints](../../features/data-acceleration/constraints.md)
 
 ```yaml
 datasets:
diff --git a/spiceaidocs/docs/reference/sql/select.md b/spiceaidocs/docs/reference/sql/select.md
@@ -1,6 +1,6 @@
 ---
-title: "SELECT"
-sidebar_label: "SELECT"
+title: 'SELECT'
+sidebar_label: 'SELECT'
 pagination_prev: 'reference/sql/index'
 pagination_next: null
 sidebar_position: 1
@@ -27,7 +27,7 @@ Spice supports the following syntax for queries:
 [ [UNION](#union-clause) [ ALL | select ]  
 [ [ORDER BY](#order-by-clause) expression \[ ASC | DESC \][, ...] ]  
 [ [LIMIT](#limit-clause) count ]  
-[ [EXCLUDE | EXCEPT](#exclude-and-except-clause) ]  
+[ [EXCLUDE | EXCEPT](#exclude-and-except-clause) ]
 
 ### WITH clause
 
@@ -40,8 +40,8 @@ SELECT a, b FROM x;
 
 ### SELECT clause
 
-The `SELECT` clause is used to select data from a database by defining the colummns it returns.  Each `select_expr` in the
- SELECT list can be an expression or wildcards.
+The `SELECT` clause is used to select data from a database by defining the colummns it returns. Each `select_expr` in the
+SELECT list can be an expression or wildcards.
 
 Example:
 
@@ -68,7 +68,7 @@ SELECT t.a FROM table AS t
 
 ### WHERE clause
 
-The `WHERE` clause is used define the conditions to filter the query results.  
+The `WHERE` clause is used define the conditions to filter the query results.
 
 Example:
 
@@ -178,10 +178,10 @@ select * from x cross join x y;
 
 ### GROUP BY clause
 
-The `GROUP BY` clause groups together input rows that have the same value into summary rows.  
+The `GROUP BY` clause groups together input rows that have the same value into summary rows.
 
 `GROUP BY` is typically used with aggregrate functions (`COUNT()`, `MAX()`, `SUM()`), but if no aggregate functions are
- included, the query with a `GROUP BY` clause is the same as `SELECT DISTINCT`.
+included, the query with a `GROUP BY` clause is the same as `SELECT DISTINCT`.
 
 Example:
 
@@ -210,8 +210,8 @@ SELECT a, b, MAX(c) FROM table GROUP BY a, b HAVING MAX(c) > 10
 
 ### UNION clause
 
-The `UNION` clause combines the results of two or more `SELECT` statments.  By default `UNION` removes
- duplicates.  To include duplicates, use `UNION ALL`.
+The `UNION` clause combines the results of two or more `SELECT` statments. By default `UNION` removes
+duplicates. To include duplicates, use `UNION ALL`.
 
 Example:
 
diff --git a/spiceaidocs/docusaurus.config.ts b/spiceaidocs/docusaurus.config.ts
@@ -165,8 +165,8 @@ const config: Config = {
             to: '/features/data-ingestion',
           },
           {
-            from: '/local-acceleration',
-            to: '/features/local-acceleration',
+            from: '/data-acceleration',
+            to: '/features/data-acceleration',
           },
         ],
       },
