Skip to content

Add link-checker agentic workflow for automated documentation maintenance#158

Merged
pelikhan merged 5 commits intomainfrom
copilot/fix-broken-links-in-docs
Feb 17, 2026
Merged

Add link-checker agentic workflow for automated documentation maintenance#158
pelikhan merged 5 commits intomainfrom
copilot/fix-broken-links-in-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 17, 2026

Automated daily workflow that finds and fixes broken HTTP(S) links in documentation files.

Implementation

Pre-processing step (bash script):

  • Extracts all HTTP(S) links from docs/*.md and README.md using grep
  • Tests each link via curl with 10s timeout
  • Generates test report at /tmp/link-check-results.md

AI agent:

  • Processes test results to identify broken links
  • Uses cache-memory to skip known unfixable URLs
  • Attempts fixes via web-fetch (URL variations, redirects, alternatives)
  • Updates markdown files with working replacements
  • Persists unfixable links to cache for future runs

Safe outputs:

  • create-pull-request: Batch fixes with [link-checker] prefix
  • noop: When all links working or all broken links cached as unfixable

Cache Memory Schema

{
  "unfixable_links": [
    {
      "url": "https://example.com/removed",
      "reason": "404 Not Found - content permanently removed",
      "first_seen": "2026-02-17"
    }
  ],
  "last_run": "2026-02-17"
}

Configuration

  • Schedule: Daily on weekdays (fuzzy scheduling)
  • Network: node, python, github ecosystems
  • Tools: github (toolsets: default), cache-memory, web-fetch
  • Timeout: 60 minutes

Files

  • .github/workflows/link-checker.md - Workflow definition
  • .github/workflows/link-checker.lock.yml - Compiled Actions workflow
  • docs/link-checker.md - Documentation

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v0.45.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.45.3 --jq .object.sha (http block)
  • https://api.github.com/user
    • Triggering command: /usr/bin/gh gh api user --jq .login (http block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits February 17, 2026 04:03
Create automated workflow to check and fix broken links in documentation:
- Runs daily on weekdays
- Pre-step collects and tests all links using scripting
- Uses cache memory to track unfixable broken links
- Creates PRs with fixed URLs when needed
- Uses web-fetch for finding alternative URLs

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Create comprehensive documentation for the new link checker workflow and add it to the README

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Update docs to correctly state that PRs are created as ready-to-review (non-draft)

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Create agentic workflow to check and fix documentation links Add link-checker agentic workflow for automated documentation maintenance Feb 17, 2026
Copilot AI requested a review from pelikhan February 17, 2026 04:06
@pelikhan pelikhan marked this pull request as ready for review February 17, 2026 04:18
@pelikhan pelikhan merged commit 82dcb1c into main Feb 17, 2026
2 checks passed
@pelikhan pelikhan deleted the copilot/fix-broken-links-in-docs branch February 17, 2026 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants