If you are looking to explore the Spice.ai OSS documentation, please go to the documentation website:
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.
The Spice docs are built using Docusaurus hosted on GitHub Pages.
The spiceaidocs directory contains the Docusaurus project, markdown files, and theme configurations.
- Ensure pre-requisites are installed
- Clone this repository
git clone https://github.com/spiceai/docs.git
- Change to spiceaidocs directory:
cd ./docs/spiceaidocs
- Install npm packages:
npm install
- Make sure you're still in the
spiceaidocs
directory - Run
npm start
- Navigate to
https://localhost:3000/
- Fork repo into your account
- Create new branch
- Commit and push changes to forked branch
- Submit pull request from downstream branch to the upstream branch for the correct version you are targeting
- Staging site will automatically get created and linked to PR to review and test