Docs

docs(readme): refresh copy and docs links #22

	name: Docs

	on:
	push:
	branches:
	- main
	paths:
	- ".github/workflows/docs.yml"
	- "docs/**"
	- "mkdocs.yml"
	- "requirements-docs.txt"
	- "README.md"
	- "CONTRIBUTING.md"
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: pages
	cancel-in-progress: true

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v4

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.x"
	cache: pip
	cache-dependency-path: requirements-docs.txt

	- name: Configure Pages
	uses: actions/configure-pages@v5

	- name: Install docs dependencies
	run: python -m pip install --upgrade pip -r requirements-docs.txt

	- name: Build docs
	run: python -m mkdocs build --strict

	- name: Upload Pages artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	if: github.ref == 'refs/heads/main'
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu