Skip to content

docs: document that agr add auto-creates config for users who want to… #52

docs: document that agr add auto-creates config for users who want to…

docs: document that agr add auto-creates config for users who want to… #52

Workflow file for this run

name: Build and Deploy Docs
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: pip install mkdocs-material
- name: Build docs
run: mkdocs build
- name: Prepare deploy directory
run: |
mkdir -p deploy/site
cp docs/index.html deploy/
cp -r docs/site/* deploy/site/
# Serve llms.txt files at site root (convention for AI tool discovery)
cp docs/site/llms.txt deploy/llms.txt
cp docs/site/llms-full.txt deploy/llms-full.txt
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./deploy
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