Add llms.txt generator for LLM-friendly documentation (#2912)

* Add llms.txt generator for LLM-friendly documentation

* Fix codespell skip for llms.txt files

* Refactor build_llms_txt.py: DRY, TypedDict, walrus operator

* docs: update llms.txt files

Generated by GitHub Actions

* Add Python 3.11+ requirement note to llms-txt env

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: koxudaxi

.github/workflows/codespell.yaml

@@ -27,4 +27,4 @@ jobs:
         uses: codespell-project/actions-codespell@v2
         with:
           exclude_file: CODE_OF_CONDUCT.md
-          skip: ./docs/cli-reference
+          skip: ./docs/cli-reference,./docs/llms.txt,./docs/llms-full.txt

.github/workflows/llms-txt.yaml

@@ -0,0 +1,72 @@
+name: Update llms.txt
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**/*.md'
+      - 'zensical.toml'
+      - 'scripts/build_llms_txt.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'docs/**/*.md'
+      - 'zensical.toml'
+      - 'scripts/build_llms_txt.py'
+  pull_request_target:
+    types: [labeled]
+    paths:
+      - 'docs/**/*.md'
+      - 'zensical.toml'
+      - 'scripts/build_llms_txt.py'
+
+permissions:
+  contents: write
+
+jobs:
+  update-llms-txt:
+    if: |
+      github.event_name == 'push' ||
+      !github.event.pull_request.head.repo.fork ||
+      github.actor == 'koxudaxi' ||
+      github.actor == 'gaborbernat' ||
+      github.actor == 'ilovelinux' ||
+      (github.event_name == 'pull_request_target' && github.event.label.name == 'safe-to-fix' &&
+       (github.event.sender.login == 'koxudaxi' ||
+        github.event.sender.login == 'gaborbernat' ||
+        github.event.sender.login == 'ilovelinux'))
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+      - uses: actions/checkout@v4
+        if: github.event_name == 'push' || github.event_name == 'pull_request_target' || github.event.pull_request.head.repo.full_name == github.repository
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref || github.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+          token: ${{ secrets.PAT }}
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install tox
+        run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
+      - name: Setup environment
+        run: tox run -vv --notest --skip-missing-interpreters false -e llms-txt
+        env:
+          UV_PYTHON_PREFERENCE: "only-managed"
+      - name: Build llms.txt
+        run: .tox/llms-txt/bin/python scripts/build_llms_txt.py
+      - name: Commit and push if changed
+        if: github.event_name == 'push' || github.event_name == 'pull_request_target' || github.event.pull_request.head.repo.full_name == github.repository
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add docs/llms.txt docs/llms-full.txt
+          git diff --staged --quiet || git commit -m "docs: update llms.txt files
+
+          Generated by GitHub Actions"
+          git push