awesomeWM/awesome

Automatically catch broken links in the docs

Open

#3,098 opened on May 10, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Lua (6,882 stars) (620 forks)batch import
docenhancementgood first issue

Description

Currently, things like #3097 are caught accidentally when someone sees the breakage. Is it possible to automatically extract all links from the generated docs and catch broken links? Surely there are tools for that.

Contributor guide

Tech stack
None
Domain
documentationtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Luadocumentation build process
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the documentation build process in the repository, likely in the docs/ folder and the Makefile or a script. Look for tools like htmlproofer or broken link checker that can be integrated into the build. Check if there is a CI workflow (e.g., GitHub Actions) that could run the link checker automatically. Also review the linked issue #3097 for context on the breakage.
Automatically catch broken links in the docs · awesomeWM/awesome#3098 | Good First Issue