📝 update docs #36

	name: Main

	on:
	push:
	branches:
	- main
	pull_request:
	types: [opened, synchronize, reopened, ready_for_review]

	jobs:
	quality:
	runs-on: ubuntu-latest
	steps:
	- name: Check out
	uses: actions/checkout@v4

	- uses: actions/cache@v4
	with:
	path: ~/.cache/pre-commit
	key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}

	- name: Set up the environment
	uses: ./.github/actions/setup-python-env

	- name: Run checks
	run: make check

	tests-and-type-check:
	runs-on: ubuntu-latest
	strategy:
	matrix:
	python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
	fail-fast: false
	defaults:
	run:
	shell: bash
	steps:
	- name: Check out
	uses: actions/checkout@v4

	- name: Set up the environment
	uses: ./.github/actions/setup-python-env
	with:
	python-version: ${{ matrix.python-version }}

	- name : Install Nmap and Masscan
	run: \|
	sudo apt-get update
	sudo apt-get install -y nmap masscan
	shell: bash

	- name: Run tests
	run: make unit-test

	- name: Check typing
	run: uv run mypy

	- name: Upload coverage reports to Codecov with GitHub Action on Python 3.9
	uses: codecov/codecov-action@v4
	if: ${{ matrix.python-version == '3.9' }}

	check-docs:
	runs-on: ubuntu-latest
	steps:
	- name: Check out
	uses: actions/checkout@v4

	- name: Set up the environment
	uses: ./.github/actions/setup-python-env

	- name: Check if documentation can be built
	run: uv run mkdocs build -s

Provide feedback