docs: update readme #37

	name: Doc Site
	on:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	- "README.md"
	- "mkdocs.yaml"
	- ".github/workflows/docsite.yml"

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: "pages"
	cancel-in-progress: true

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Check out repository
	uses: actions/checkout@v4
	- name: Set up python
	id: setup-python
	uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install Poetry
	uses: snok/install-poetry@v1
	with:
	virtualenvs-create: true
	virtualenvs-in-project: true
	installer-parallel: true
	- name: Load cached venv
	id: cached-poetry-dependencies
	uses: actions/cache@v4
	with:
	path: .venv
	key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
	- name: Install dependencies
	if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
	run: poetry install --no-interaction --no-root
	- name: Install project
	run: poetry install --no-interaction
	- name: Publish docs
	run: poetry run poe doc-html
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v1
	- name: Deploy to GitHub Pages
	uses: actions/deploy-pages@v1

Provide feedback