Skip to content

README.md

Latest commit

 

History

History
58 lines (37 loc) · 1.38 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.38 KB

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

Environment setup

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

Run local server

  1. Make sure you're still in the website directory
  2. Run
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