docs(#496): add some docstrings to user facing specs on the expected … #692

	# We do not include static_type_checks as a pre-commit hook because pre-commit hooks
	# are installed in their own virtual environment, so static_type_checks cannot
	# use stubs from imports
	name: static_type_checks

	on:
	pull_request:
	push:
	branches: [main]

	jobs:
	static_type_checks:
	runs-on: ubuntu-latest
	permissions:
	pull-requests: write
	steps:
	- name: Checkout (GitHub)
	uses: actions/checkout@v3

	- name: Create github hosts file
	run: \| # If this file is not created, the dev container fails because of non-existent mount
	mkdir -p ~/.config/gh
	touch ~/.config/gh/hosts.yml

	- name: Pre-build dev container image
	uses: devcontainers/[email protected]
	with:
	runCmd: \|
	inv types

Provide feedback