Docs

docs(code): Document the three consensus modes and how to pick a `Val… #33

	name: Docs

	on:
	push:
	branches: main

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

	concurrency:
	group: deploy
	cancel-in-progress: false

	jobs:
	changes:
	name: Detect changes
	runs-on: ubuntu-latest
	permissions:
	pull-requests: read
	outputs:
	code: ${{ steps.filter.outputs.code }}
	steps:
	- uses: actions/checkout@v4
	- uses: dorny/paths-filter@v3
	id: filter
	with:
	filters: \|
	code:
	- 'code/**'

	build:
	name: Build
	needs: changes
	if: ${{ needs.changes.outputs.code == 'true' \|\| github.ref == 'refs/heads/main' }}
	runs-on: ubuntu-latest
	defaults:
	run:
	working-directory: code
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4
	- name: Install Protoc
	uses: arduino/setup-protoc@v3
	with:
	repo-token: ${{ secrets.GITHUB_TOKEN }}
	- name: Setup Rust toolchain
	uses: actions-rust-lang/setup-rust-toolchain@v1
	with:
	cache-workspaces: "code"
	- name: Setup pages
	id: pages
	uses: actions/configure-pages@v4
	- name: Clean docs folder
	run: cargo clean --doc
	- name: Build docs
	run: cargo doc --no-deps
	- name: Add redirect
	run: echo '<meta http-equiv="refresh" content="0;url=informalsystems_malachitebft_core_consensus/index.html">' > target/doc/index.html
	- name: Remove lock file
	run: rm target/doc/.lock
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: code/target/doc

	deploy:
	name: Deploy
	runs-on: ubuntu-latest
	needs: build
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback