For an overview of all available workflows, see the main README.
Scan documentation for broken links, find replacements, and create PRs with fixes
The Link Checker workflow scans markdown files for HTTP(S) links, tests each one, finds replacements for broken links, and creates pull requests with fixes. Uses cache memory to avoid repeated attempts on unfixable links.
# Install the 'gh aw' extension
gh extension install github/gh-aw
# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/link-checkerThis walks you through adding the workflow to your repository.
graph LR
A[Scan Markdown Files] --> B[Extract Links]
B --> C[Test Each Link]
C --> D{Broken?}
D -->|Yes| E[Search for Replacement]
E --> F{Fixable?}
F -->|Yes| G[Update Link]
F -->|No| H[Add to Cache]
D -->|No| I[Skip]
G --> J[Create PR]
A bash script pre-processes links before the AI agent runs. The agent investigates broken links, tries common variations (www, http vs https), and uses web-fetch to find where content moved.
The workflow runs on weekdays with a 60-minute timeout. Creates ready-to-review PRs labeled documentation and automated.
After editing run gh aw compile to update the workflow and commit all changes to the default branch.
To automatically trigger CI checks on PRs created by this workflow, configure an additional repository secret GH_AW_CI_TRIGGER_TOKEN. See the triggering CI documentation for setup instructions.