Docs

chore: update resolver version in Cargo.toml (#557) #6

	name: "Docs"
	on:
	workflow_dispatch:
	pull_request:
	push:
	branches:
	- main

	env:
	RUST_BACKTRACE: 1
	CARGO_TERM_COLOR: always
	CLICOLOR: 1
	CLICOLOR_FORCE: 1

	permissions:
	contents: read

	jobs:
	# Check links in docs
	check-links:
	name: "Check links"
	runs-on: ubuntu-24.04
	steps:
	- name: Checkout sources
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
	with:
	persist-credentials: false

	- name: Check repo-local links
	uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # v2.4.1
	with:
	args: ". --offline --verbose --no-progress"
	fail: true

	# Generate docs content
	generate-docs:
	name: "Generate usage docs"
	runs-on: ubuntu-24.04
	steps:
	- name: Checkout
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
	with:
	persist-credentials: false

	- name: Set up rust toolchain
	uses: dtolnay/rust-toolchain@stable
	with:
	toolchain: stable

	- name: Enable cargo cache
	uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8

	- name: Create dirs
	run: mkdir -p ./md ./man

	- name: Build markdown info
	run: cargo xtask generate-markdown --out ./md/brush.md

	- name: Upload markdown docs
	uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
	with:
	name: docs-markdown
	path: md

	- name: Build man pages
	run: cargo xtask generate-man --output-dir ./man

	- name: Upload man pages
	uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
	with:
	name: docs-man
	path: man

Provide feedback