Repository navigation

Docs

Merge pull request #621 from brazilian-utils/hyan/eloquent-hamilton-1… #9

	# Builds the documentation site and publishes it to GitHub Pages. Everything the site needs that a
	# script can write - the per-page shells, the sitemap, llms.txt, llms-full.txt and the examples of
	# the document field page - is written here rather than kept in the repository, so a page and what
	# it is generated from can never disagree.
	#
	# This needs Pages set to "GitHub Actions" (Settings -> Pages -> Build and deployment -> Source);
	# serving the branch directly would publish `docs/` without these files.
	name: Docs

	on:
	push:
	branches: [main]
	paths:
	- docs/**
	- scripts/**
	- package.json
	- .github/workflows/docs.yml
	workflow_dispatch:

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

	permissions:
	contents: read

	jobs:
	deploy:
	name: Build and deploy
	runs-on: ubuntu-latest
	timeout-minutes: 15

	permissions:
	pages: write
	id-token: write

	environment:
	name: github-pages
	url: ${{ steps.deploy.outputs.page_url }}

	steps:
	- name: Checkout code
	uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
	with:
	persist-credentials: false

	- name: Setup
	uses: ./.github/actions/setup

	- name: Build the site
	run: npm run build:docs

	- name: Configure Pages
	uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

	- name: Upload the site
	uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
	with:
	path: docs

	- name: Deploy to Pages
	id: deploy
	uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1