feat: update documentation with ongoing issues #28

	name: Documentation

	on:
	push:
	paths:
	- docs/**
	- mkdocs.yml
	- .github/workflows/doc.yml

	permissions:
	contents: write

	jobs:
	deploy:
	runs-on: ubuntu-latest
	if: github.ref == 'refs/heads/main'
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install '.[documentation]'
	- name: Configure Git Credentials
	run: \|
	git config user.name github-actions[bot]
	git config user.email 41898282+github-actions[bot]@users.noreply.github.com
	- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
	- uses: actions/cache@v4
	with:
	key: mkdocs-material-${{ env.cache_id }}
	path: .cache
	restore-keys: \|
	mkdocs-material-
	- run: mkdocs gh-deploy --force

Provide feedback