Compass Docs

The source code for the Compass documentation site.

To see the Compass source code, visit: SwitchbackTech/compass. The most up-to-date, low-level documentation lives in the Compass codebase docs.

Installation

Install doc site dependencies:

yarn

Run local doc site server:

yarn start

This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Generate static content into the build dir, which can be served using any static contents hosting service.

yarn build

Push to main, which will trigger a Vercel deployment.