explainx.ai
Docsprompt onlyMedium

Broken Docs Link Fixer

Automatically detects and removes broken links from documentation files to improve usability and SEO.

← all loops
documentationlinksautomationseoquality

Goal

Remove broken links

How to Run

Run link checker on docs, identify broken links, fix or remove them, and repeat until no broken links remain.

  1. 01

    Run Link Checker

    Execute the link checker tool to scan all documentation files for broken links.

  2. 02

    Analyze Results

    Review the output to identify which links are broken and where they are located.

  3. 03

    Fix Broken Links

    Update or remove broken links in the documentation files. Verify replacements if applicable.

  4. 04

    Repeat Until Clean

    Re-run the link checker after each fix until no broken links are detected.

Workflow Steps

  1. 01

    Run Link Checker

    Use the configured link checker to scan all documentation files.

  2. 02

    Gather Broken Links Report

    Collect and parse the list of broken links from the tool output.

  3. 03

    Identify Affected Files

    Map broken links to their corresponding documentation files.

  4. 04

    Edit Documentation

    Remove or replace broken links in the identified files.

  5. 05

    Verify Changes

    Re-run the link checker to confirm all broken links are resolved.

Kickoff Prompt

Start the "Broken Docs Link Fixer" loop.

Goal: Remove broken links
Max iterations: 10
Between iterations run: link checker
Exit when: No broken links


Initiate the broken docs link fixer loop. Start by running the link checker on all documentation files and prepare to fix any issues found.

Self-pace this loop. After each iteration, run `link checker` and evaluate the output, and only continue if the exit condition is not met (No broken links). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.

Guardrails

hardcoded
  • ·Only modify documentation files (e.g., .md, .rst, .html).
  • ·Do not delete content without confirming the link is truly broken.
  • ·Ensure any replaced URLs are valid and relevant.
  • ·Backup changes before applying to prevent data loss.

Flow Diagram

rendering…

Related loops — Docs

Docs

Changelog Generator

Automatically generates and maintains a project's CHANGELOG.md file by analyzing code changes, commits, or version control history to produce structured release notes.

Docs

Example Coverage Builder

Automatically identifies areas in your codebase lacking usage examples and iteratively adds them to improve documentation coverage. The agent focuses on generating practical, copy-paste-friendly examples for functions, methods, and components that currently lack adequate documentation.

Docs

API Docs Sync

Automatically synchronizes API documentation with the codebase to ensure no drift occurs between implementation and documented interfaces. This loop detects discrepancies, generates necessary updates, and applies them while respecting guardrails to maintain consistency and quality.