Skip to content

Commit 894ae5f

Browse files
authored
Update docs structure and main page (#117)
1 parent 6ad0fb3 commit 894ae5f

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

spiceaidocs/content/en/_index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ no_list: true
66
# Spice
77
## What is Spice?
88

9-
**Spice** is a portable runtime that provides developers with a unified SQL query interface to locally accelerate and query data tables sourced from any database, data warehouse, or data lake.
9+
**Spice** is a small, portable runtime that provides developers with a unified SQL query interface to locally accelerate and query data tables sourced from any database, data warehouse, or data lake.
1010

1111
Spice makes it easy to build data-driven and data-intensive applications by streamlining the use of data and machine learning (ML) in software.
1212

@@ -26,24 +26,23 @@ Spice makes querying data by SQL across one or more data sources simple and fast
2626

2727
### Example Use-Cases
2828

29-
**1. Faster frontends.** Accelerate and co-locate data views with your frontend application, to serve more concurrent users with faster page loads and data updates.
29+
**1. Faster applications and frontends.** Accelerate and co-locate datasets with applications and frontends, to serve more concurrent queries and users with faster page loads and data updates.
3030

31-
**2. Faster analytics and BI.**
31+
**2. Faster analytics and BI.** Faster, more responsive dashboards without massive compute costs.
3232

33-
**3. Faster machine learning training and inferencing.**
33+
**3. Faster data pipelines, machine learning training and inferencing.** Co-locate datasets in pipelines where the data is needed to minimize data-movement and improve query performance.
3434

3535
⚠️ **DEVELOPER PREVIEW** Spice is under active **alpha** stage development and is not intended to be used in production until its **1.0-stable** release.
3636

37-
### Join us!
37+
### Connect with us
3838

39-
We greatly appreciate and value your support! You can help Spice.ai in a number of ways:
39+
We greatly appreciate and value your support! You can help Spice in a number of ways:
4040

4141
- ⭐️ Star this repo.
42-
- Build an app with Spice.ai and send us feedback and suggestions at [hey@spiceai.io](mailto:hey@spiceai.io) or on [Discord](https://discord.gg/kZnTfneP5u).
42+
- Build an app with Spice.ai and send us feedback and suggestions at [hey@spice.ai](mailto:hey@spice.ai) or on [Discord](https://discord.gg/kZnTfneP5u), [X](https://twitter.com/spice_ai), or [LinkedIn](https://www.linkedin.com/company/74148478).
4343
- [File an issue](https://github.com/spiceai/spiceai/issues/new) if you see something not quite working correctly.
44-
- Follow us on [Reddit](https://www.reddit.com/r/spiceai), [Twitter](https://twitter.com/SpiceAIHQ), and [LinkedIn](https://www.linkedin.com/company/74148478).
45-
- Join our team ([We’re hiring!](https://spiceai.io/careers))
46-
- Contribute code or documentation to the project (see [CONTRIBUTING.md](CONTRIBUTING.md)).
44+
- Join our team ([We’re hiring!](https://spice.ai/careers))
45+
- Contribute code or documentation to the project (see [CONTRIBUTING.md](https://github.com/spiceai/spiceai/blob/trunk/CONTRIBUTING.md)).
4746

4847
We’re also starting a community call series soon!
4948

spiceaidocs/content/en/reference/Spicepod/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The name of the Spicepod.
2626

2727
## `secrets`
2828

29-
The secrets section in the Spicepod manifest is optional and is used to configure how secrets are stored and accessed by the Spicepod. [Learn more]({{<ref "reference/secrets">}}).
29+
The secrets section in the Spicepod manifest is optional and is used to configure how secrets are stored and accessed by the Spicepod. [Learn more]({{<ref "secrets">}}).
3030

3131
### `secrets.store`
3232

spiceaidocs/content/en/reference/Secrets/_index.md renamed to spiceaidocs/content/en/secrets/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
type: docs
3-
title: "Spice Secrets"
4-
linkTitle: "Spice Secrets"
3+
title: "Secrets"
4+
linkTitle: "Secrets"
55
description: ''
6-
weight: 70
6+
weight: 40
77
---
88

99
## Secret

0 commit comments

Comments
 (0)