refactor: rename tutorials/*/index.md to README.md for GitHub auto-re… #226
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: Docs Health | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Validate Docs Health | |
| run: | | |
| python scripts/docs_health.py \ | |
| --baseline-file .github/baselines/broken-local-links.txt \ | |
| --json-output docs-health-report.json | |
| - name: Validate Tutorial Manifest Is Current | |
| run: | | |
| python scripts/generate_tutorial_manifest.py --output /tmp/tutorial-manifest.json | |
| diff -u tutorials/tutorial-manifest.json /tmp/tutorial-manifest.json | |
| - name: Validate Discoverability Assets Are Current | |
| run: | | |
| python scripts/generate_discoverability_assets.py \ | |
| --output-json /tmp/tutorial-index.json \ | |
| --llms /tmp/llms.txt \ | |
| --llms-full /tmp/llms-full.txt \ | |
| --directory-md /tmp/tutorial-directory.md \ | |
| --intent-md /tmp/search-intent-map.md \ | |
| --jsonld /tmp/tutorial-itemlist.schema.json \ | |
| --query-hub-md /tmp/query-hub.md \ | |
| --query-coverage-json /tmp/query-coverage.json | |
| diff -u discoverability/tutorial-index.json /tmp/tutorial-index.json | |
| diff -u discoverability/tutorial-directory.md /tmp/tutorial-directory.md | |
| diff -u discoverability/query-hub.md /tmp/query-hub.md | |
| diff -u discoverability/query-coverage.json /tmp/query-coverage.json | |
| diff -u discoverability/search-intent-map.md /tmp/search-intent-map.md | |
| diff -u discoverability/tutorial-itemlist.schema.json /tmp/tutorial-itemlist.schema.json | |
| diff -u llms.txt /tmp/llms.txt | |
| diff -u llms-full.txt /tmp/llms-full.txt | |
| - name: Validate Tutorials README Snapshot Is Current | |
| run: | | |
| python scripts/update_tutorials_readme_snapshot.py --output /tmp/tutorials-readme.md | |
| diff -u tutorials/README.md /tmp/tutorials-readme.md | |
| - name: Validate Format v2 Tutorial Indexes | |
| run: | | |
| python scripts/check_index_format_v2.py | |
| - name: Validate Repository Status Docs Are Current | |
| run: | | |
| python scripts/update_repo_status_docs.py \ | |
| --structure-output /tmp/TUTORIAL_STRUCTURE.md \ | |
| --gaps-output /tmp/CONTENT_GAPS_ANALYSIS.md | |
| diff -u TUTORIAL_STRUCTURE.md /tmp/TUTORIAL_STRUCTURE.md | |
| diff -u CONTENT_GAPS_ANALYSIS.md /tmp/CONTENT_GAPS_ANALYSIS.md | |
| - name: Validate Freshness Markers | |
| run: | | |
| python scripts/staleness_audit.py --max-age-days 10 --fail-on-stale | |
| - name: Report Stale Release Claims | |
| run: | | |
| python scripts/release_claims_audit.py --max-age-days 120 |