Add curl validation guide and improve markdown documentation #27
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: Link Checker | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| - km-updates | |
| paths: | |
| - '**.md' | |
| - 'docs/**' | |
| - 'training-data/**/*.json' | |
| workflow_dispatch: # Allow manual triggering | |
| jobs: | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Check links in markdown files | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| # Use the lychee.toml config file for all settings | |
| # Just check current directory recursively - lychee finds markdown files automatically | |
| args: --config .github/lychee.toml --verbose --no-progress . | |
| # Don't fail the PR - just report broken links (optional check) | |
| fail: false | |
| - name: Create Issue or Comment on PR | |
| if: always() | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| ## 🔗 Link Check Results | |
| The link checker has completed. This is an **optional check** and will not block the PR. | |
| [View workflow run for details](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) | |
| If broken links were found, please review them at your convenience. |