Repository navigation
documentation: fix typos, broken links and docstrings that don't match the code #16
Workflow file for this run
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
| name: Validate Cheat Sheet | |
| # Runs on pull requests that touch the cheat sheet. Unlike the publish workflow, | |
| # this only validates -- it never deploys -- so it is safe to run on PRs. | |
| on: | |
| pull_request: | |
| paths: | |
| - "doc/cheat_sheet/**" | |
| - "doc/genai_cheat_sheet.md" | |
| - ".github/workflows/validate-cheat-sheet.yml" | |
| jobs: | |
| verify-snippets: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.12" | |
| - name: Install the SDK | |
| run: pip install . | |
| - name: Verify snippets, language parity and GenAI sync | |
| run: python doc/cheat_sheet/_scripts/verify_snippets.py | |
| - name: Check the GenAI cheat sheet is regenerated | |
| run: python doc/cheat_sheet/_scripts/generate_genai_cheat_sheet.py --check |