HelpLogin
© 2022-2025 Spice AI, Inc.
SQL Query ReferenceDocsFAQSupport
PrivacyTerms
Status
Home
Datasets
Models
https://avatars.githubusercontent.com/spiceaispiceai/docs
spiceai / docs
🌶️0
Datasets
Models
spiceai/docs/README.md

Spice.ai OSS documentation

If you are looking to explore the Spice.ai OSS documentation, please go to the documentation website:

https://docs.spiceai.org

This repo contains the markdown files which generate the above website. See below for guidance on running with a local environment to contribute to the docs.

Overview

The Spice docs are built using Docusaurus hosted on GitHub Pages.

The website directory contains the Docusaurus project, markdown files, and theme configurations.

Pre-requisites

  • Node.js
  • Docusaurus

Environment setup

  1. Ensure pre-requisites are installed
  2. Clone this repository
git clone https://github.com/spiceai/docs.git
git clone https://github.com/spiceai/docs.git
  1. Change to website directory:
cd ./docs/website
cd ./docs/website
  1. Install npm packages:
npm install
npm install

Run local server

  1. Make sure you're still in the website directory
  2. Run
npm start
npm start
  1. Navigate to http://localhost:3000/

Update docs

  1. Fork repo into your account
  2. Create new branch
  3. Commit and push changes to forked branch
  4. Submit pull request from downstream branch to the upstream branch for the correct version you are targeting
  5. Staging site will automatically get created and linked to PR to review and test
Description

Documentation for Spice.ai

LicenseApache License 2.0
Models
View all models
assistant
openai:gpt-4o
docs_writer
openai:gpt-4o
Datasets
View all datasets
spiceai.docs
GitHub
Spice.ai OSS documentation and reference, from https://docs.spiceai.org
spiceai.cookbook
GitHub
Spice.ai OSS cookbook recipes
spiceai.blog
GitHub
Spice.ai OSS blog posts
spiceai.issues
GitHub
Spice.ai OSS issues from https://github.com/spiceai/spiceai/issues
ContributorslukekimlukekimphillipleblancphillipleblancewgeniusewgeniussgrebnovsgrebnovJeadieJeadieSevenannnSevenannnpeaseepeaseey-f-uy-f-ukarifabrikarifabridigadeeshdigadeeshdependabot[bot]dependabot[bot]gloomweavergloomweaverAdvaypAdvayphaardvarkhaardvarkmitchdevenportmitchdevenportbreak-the-buildbreak-the-buildeadgbeareadgbearAdm28Adm28Corentin-proCorentin-prokczimmkczimmmach-kernelmach-kerneledmondopedmondopkostasptkostasptnuvicnuvic