ewgenius / docs

Documentation for Spice.ai

Spice.ai documentation

If you are looking to explore the Spice.ai 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.ai docs are built using Hugo with the Docsy theme, hosted on GitHub Pages.

The spiceaidocs directory contains the hugo project, markdown files, and theme configurations.

Pre-requisites

• Hugo extended version
• Node.js

Environment setup

1. Ensure pre-requisites are installed
2. Clone this repository

git clone https://github.com/spiceai/docs.git

3. Change to spiceaidocs directory:

cd ./docs/spiceaidocs

4. Update submodules:

git submodule update --init --recursive

5. Install npm packages:

npm install

Run local server

1. Make sure you're still in the spiceaidocs directory
2. Run

hugo server

3. Navigate to http://localhost:1313/

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