feat: add client-side telemetry instrumentation (issue #558) #489

	name: Build and Deploy Documentation

	on:
	push:
	branches: [main]
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- 'README.md'
	- '.github/workflows/docs.yml'
	pull_request:
	branches: [main]
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- 'README.md'
	workflow_dispatch:

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

	concurrency:
	group: pages-${{ github.ref }}
	cancel-in-progress: false

	jobs:
	build:
	name: "Build Documentation"
	runs-on: ubuntu-latest
	timeout-minutes: 15
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	with:
	fetch-depth: 0 # Fetch all history for git plugins

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.12'

	- name: Install uv
	uses: astral-sh/setup-uv@v4
	with:
	version: "latest"

	- name: Cache dependencies
	uses: actions/cache@v4
	with:
	path: ~/.cache/uv
	key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}
	restore-keys: \|
	${{ runner.os }}-uv-

	- name: Install dependencies
	run: \|
	uv pip install --system -e ".[docs]"

	- name: Setup Pages
	id: pages
	uses: actions/configure-pages@v4

	- name: Build documentation
	run: \|
	mkdocs build --clean

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

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

Navigation Menu