Hiro developer documentation

This repository holds the source for the Hiro developer documentation website, which is deployed at docs.hiro.so. This website is built using Docusaurus.

Getting started

Contribution Prerequisites

Before running Hiro Docs, ensure that you have the following tools installed:

1. Install NodeJS that includes npm
2. Install yarn by running npm install --global yarn

If you are using a mac, we highly recommend using Homebrew to install these tools.

You should also be familiar with Git.

Installation

Use the following command to install local build and development dependencies.

yarn

Local Development

The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Make sure that you have installed dependencies before doing local development.

yarn start

Build

The following command will build the final static website into the build directory.

yarn build

Deployment

This website is configured to deploy automatically on PR merge using Vercel.