Skip to content

Bento Docs

This repository hosts the versioned documentation for the Bento portal, built with MkDocs and Mike, and deployed to GitHub Pages.

Installation

Install dependencies with Poetry:

poetry install

(Optional) Activate the Poetry shell:

poetry shell

Local Development

Preview the docs with live reload:

mkdocs serve

Build the static site:

mkdocs build --strict

Deployment

Manual deploy with Mike:

mike deploy <version> --push            # deploys docs under /<version>/ on gh-pages
mike alias <version> latest --update-aliases --push  # update the latest alias

CI/CD

  • Release deploy: GitHub Actions workflow (.github/workflows/deploy-docs.yml) runs on GitHub Release to deploy the tagged version and update latest.
  • Docs build & test: CI workflow (.github/workflows/ci.yml) on push/PR builds docs (mkdocs build --strict) and runs tests.