Minor tweaks to documentation #23

	name: CI

	env:
	TYPOS_LINK: "https://github.com/crate-ci/typos/releases/download"
	TYPOS_VERSION: "1.23.4"

	on:
	push:
	branches:
	- main
	pull_request: {}

	jobs:
	checks:
	runs-on: ubuntu-24.04
	steps:
	- name: Setup Rust
	uses: tracel-ai/github-actions/setup-rust@v1
	with:
	rust-toolchain: stable
	cache-key: stable-linux
	# --------------------------------------------------------------------------------
	- name: Audit
	run: cargo xtask check audit
	# --------------------------------------------------------------------------------
	- name: Format
	shell: bash
	env:
	# work around for colors
	# see: https://github.com/rust-lang/rustfmt/issues/3385
	TERM: xterm-256color
	run: cargo xtask check format
	# --------------------------------------------------------------------------------
	- name: Typos
	uses: tracel-ai/github-actions/check-typos@v1

	tests:
	runs-on: amd-rx7600
	steps:
	- name: Setup Rust
	uses: tracel-ai/github-actions/setup-rust@v1
	with:
	rust-toolchain: stable
	cache-key: stable-linux
	# --------------------------------------------------------------------------------
	- name: Lint
	run: cargo xtask check lint
	# --------------------------------------------------------------------------------
	- name: Unit Tests
	shell: bash
	run: cargo xtask test unit
	# --------------------------------------------------------------------------------
	- name: Integration Tests
	shell: bash
	run: cargo xtask test integration
	# --------------------------------------------------------------------------------
	- name: Documentation Tests
	shell: bash
	run: cargo xtask doc tests

Provide feedback