docs: improve docs #215

	name: ci

	on:
	push:
	branches:
	- master
	pull_request:
	types:
	- opened
	- edited
	- synchronize
	branches:
	- master

	jobs:
	ci:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout repository
	uses: actions/checkout@main

	- name: Setup Python
	uses: actions/setup-python@main
	with:
	python-version: 3.8

	- name: Setup Node.js
	uses: actions/setup-node@main
	with:
	node-version: 'lts/*'

	- name: Install Python dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -r requirements.txt

	- name: Install Node.js NPM global dependencies
	run: npm install -g markdownlint-cli2

	- name: Run flake8
	run: flake8 . --count --show-source --statistics

	- name: Run pylint
	run: pylint .

	- name: Run markdownlint
	run: markdownlint-cli2 .

	- name: Run pytest
	run: pytest .

Provide feedback