docs: improve documentation #177

	name: docs

	on:
	# trigger deployment on every push to main branch
	push:
	branches:
	- master
	paths:
	- 'docs/**'

	# trigger deployment manually
	workflow_dispatch:

	jobs:
	docs:
	runs-on: ubuntu-latest
	defaults:
	run:
	working-directory: docs

	steps:
	- uses: actions/checkout@v3
	with:
	# fetch all commits to get last updated time or other git log info
	fetch-depth: 0

	- name: Setup Node.js
	uses: actions/setup-node@v1
	with:
	# choose node.js version to use
	node-version: '20'

	# cache node_modules
	- name: Cache dependencies
	uses: actions/cache@v2
	id: yarn-cache
	with:
	path: \|
	**/node_modules
	key: ${{ runner.os }}-yarn-v2-${{ hashFiles('**/yarn.lock') }}
	restore-keys: \|
	${{ runner.os }}-yarn-v2-

	# install dependencies if the cache did not hit
	- name: Install dependencies
	if: steps.yarn-cache.outputs.cache-hit != 'true'
	run: yarn --frozen-lockfile

	# run build script
	- name: Build documentation site
	run: yarn build

	# please check out the docs of the workflow for more details
	# @see https://github.com/crazy-max/ghaction-github-pages
	- name: Deploy to GitHub Pages
	uses: crazy-max/ghaction-github-pages@v4
	with:
	# deploy to gh-pages branch
	target_branch: gh-pages2
	# deploy the default output dir of Vitepress
	build_dir: docs/dist
	env:
	# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Provide feedback