GTTP Documentation

Important

The docs are automatically synced with the main repository.
Please edit the docs folder there, if you want to contribute to the documentation.

You only need to contribute to this repository if you want to contribute to the documentation build process.

Local Development

The docs are generated using Docusaurus.
To run the documentation locally, you need to have Node.js and pnpm installed.

To run the documentation locally, run the following command:

pnpm install # only needed on first run
pnpm start

This will start a local server and open the documentation in your default browser.
You can now edit the documentation and see the changes live.

Deployment

The documentation is automatically deployed to GitHub Pages using GitHub Actions.