improve small docs issues (#343) #628

	name: type-check
	on:
	push:
	branches:
	- "**"
	tags-ignore:
	- "."

	jobs:
	type_check:
	strategy:
	matrix:
	check: ["ruff check", "mypy --check", "ruff format --check"]

	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.13.0"

	- name: Install Poetry
	uses: snok/install-poetry@v1
	with:
	virtualenvs-create: true
	virtualenvs-in-project: true

	- name: Load cached venv
	id: cached-poetry-dependencies
	uses: actions/cache@v4
	with:
	path: .venv
	key: venv-${{ runner.os }}-python3.13.0-${{ hashFiles('poetry.lock') }}

	- name: Install dependencies and actiavte virtualenv
	if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
	run: \|
	poetry install --no-interaction

	- name: Run ${{ matrix.check }}
	run: \|
	poetry run ${{ matrix.check }} .

Provide feedback