Adding updated documentation #208

	# This workflow finds which files were changed, prints them,
	# and runs `pre-commit` on those files.

	# Inspired by the sktime library:
	# https://github.com/alan-turing-institute/sktime/blob/main/.github/workflows/test.yml

	name: Code Quality PR

	on:
	pull_request:
	branches: [main, "release/*", "dev"]

	jobs:
	code-quality:
	runs-on: ubuntu-latest

	steps:
	- name: Checkout
	uses: actions/checkout@v4

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

	- name: Install packages
	run: \|
	pip install .[dev]

	- name: Find modified files
	id: file_changes
	uses: trilom/[email protected]
	with:
	output: " "

	- name: List modified files
	run: echo '${{ steps.file_changes.outputs.files}}'

	- name: Run pre-commits
	uses: pre-commit/[email protected]
	with:
	extra_args: --all-files

Provide feedback