Documentation website

The website is built from the docs/ folder with MkDocs. Its pages include archives and historical records, so check the content before granting access. Links to Unity source files outside docs/ do not work on the website; open those files in the repository instead.

Preview locally

Install Python, then run these commands from the repository root:

python -m pip install -r docs/_website/requirements-docs.txt
python -m mkdocs serve --config-file docs/_website/mkdocs.yml

Open the local address printed in the terminal. To check the production build, run python -m mkdocs build --config-file docs/_website/mkdocs.yml.

Deploy with Coolify

Create an application from this repository and choose the branch to publish. Use the Dockerfile build pack, /docs as the base directory, /_website/Dockerfile as the Dockerfile location, and port 80 as the exposed port. Enable deploy on push for the selected branch. Changes to other branches do not update the published site.

Configure HTTPS and access protection in Coolify before publishing private content. Test the site in a private browser window, including any alternate domain or preview address. Ensure the container port cannot be reached directly from the internet. The Docker image contains the generated site, not the Unity project; Coolify still downloads the repository during the build.