Cube AI Documentation

This repo collects the collaborative work on Cube AI documentation.

Documentation is auto-generated from Markdown files in this repo using Docusaurus.

Installation

Doc repo can be fetched from GitHub:

git clone https://github.com/ultravioletrs/cube-docs.git
cd cube-docs

Install dependencies:

npm install

Local Development

npm run start

This command starts a local development server and opens up a browser window at http://localhost:3000. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.

You can also manually deploy using:

npm run serve

This serves the production build locally for testing before deployment.