Main

Refactor and review whole documentation #2

	name: Main

	on:
	- push
	- pull_request

	jobs:
	lint-doc:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-node@v4
	with:
	node-version: 18
	- name: Install node dependencies
	run: npm install --no-save markdownlint-cli2
	- name: Start static code analysis
	run: bash ./dev lint-doc

	lint-scripts:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Start shell script analysis tool
	run: bash ./dev lint-scripts

	build-pages:
	needs: [lint-doc, lint-scripts]
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v5
	with:
	python-version: '3.10'
	cache: 'pip'
	- name: Install dependencies
	run: bash ./dev install -e ".[all]"
	- name: Build pages
	run: bash ./dev doc-build
	- name: Fix permissions
	run: \|
	chmod -c -R +rX "site/" \| while read line; do
	echo "::warning title=Invalid file permissions automatically fixed::$line"
	done
	- name: Upload Pages artifact
	uses: actions/upload-pages-artifact@v2
	with:
	path: site

	deploy-pages:
	if: ${{ contains(github.ref, 'main') \|\| startsWith(github.ref, 'refs/tags/v') }}
	needs: [build-pages]
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v3

Provide feedback