This repository contains internal documentation for managing Team Spiral Racing. This website is built via Hyperbook and being maintained by members of Team Spiral Racing.
The easiest way to run this locally is by downloading the VSCode extension and writing documentation from there. Consult the "Getting Started" section of the Hyperbook docs to learn more.
Currently the website is build via a GitHub action and deployed to the gh-pages branch where it is served. The CNAME is hard coded and directly injected during the build process.
However, an alternative exists in the form of a Docker image. These images are built upon releases. Releases are kicked off by pushing tags and can be done by running the following commands:
git tag v*.*.*
git push origin tag v*.*.*
This project is licensed under the Creative Commons BY-NC 4.0 License. See LICENSE for more information.