Enhance documentation for DataFlow architecture and best practices, f… #81

	name: Deploy Documentation to GitHub Pages

	on:
	push:
	branches:
	- main
	paths:
	- '**'
	workflow_dispatch:

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

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

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.x'

	- name: Install dependencies
	run: pip install -r requirements.txt

	- name: Verify nav files
	run: python3 verify_nav_files.py

	- name: Docs unit tests
	run: python3 -m unittest hooks_test verify_nav_files_test -v

	- name: Build documentation
	run: mkdocs build -f mkdocs.yml

	- name: Assert llms.txt at site root
	run: test -f site/llms.txt && grep -q 'DataFlow Operator' site/llms.txt

	- name: Assert schemas published (when monorepo schemas/ exists)
	run: \|
	if [ -f ../schemas/catalog.json ] \|\| [ -f schemas/catalog.json ]; then
	test -f site/schemas/catalog.json
	test -f site/schemas/dataflow.json
	test -f site/schemas/dataflowcron.json
	grep -q '"operatorVersion"' site/schemas/catalog.json
	else
	echo "schemas/ not in checkout; skip publish assert"
	fi

	- name: Setup Pages
	uses: actions/configure-pages@v4

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

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

Navigation Menu