Deployment¶
Local Build¶
Install docs dependencies:
uv sync --no-default-groups --group docs
Run the local docs server:
uv run mkdocs serve
Build the static site:
uv run mkdocs build
GitHub Pages¶
This repository includes a GitHub Actions workflow at:
.github/workflows/docs.yml
Repository:
https://github.com/SuperagenticAI/turboagents
The workflow:
- installs the docs dependencies
- runs
uv run mkdocs build - uploads the generated
site/directory - deploys it to GitHub Pages
Requirements¶
- GitHub Pages must be enabled for the repository
- the Pages source should be set to GitHub Actions
- the repository should allow Pages deployments from workflows