docs: add MkDocs site with llms.txt support #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # GitHub Actions workflow for MkDocs documentation | |
| # Builds docs, validates llms.txt generation, and deploys to GitHub Pages | |
| name: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.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: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install dependencies | |
| run: pip install -r docs/requirements.txt | |
| - name: Build MkDocs (strict mode) | |
| run: mkdocs build --strict --verbose | |
| - name: Verify llms.txt generated | |
| run: | | |
| if [ -f site/llms.txt ]; then | |
| echo "llms.txt generated successfully" | |
| head -50 site/llms.txt | |
| else | |
| echo "Warning: llms.txt not found" | |
| fi | |
| - name: Verify llms-full.txt generated | |
| run: | | |
| if [ -f site/llms-full.txt ]; then | |
| echo "llms-full.txt generated successfully" | |
| wc -l site/llms-full.txt | |
| else | |
| echo "Warning: llms-full.txt not found" | |
| fi | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site/ | |
| deploy: | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| 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 |