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 (620 forks)batch import
docenhancementgood first issue

Repository metrics

Stars
 (6,882 stars)
PR merge metrics
 (Avg merge 37d 2h) (1 merged PR in 30d)

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

Research direction
Set up a tool like lychee or broken link checker to scan documentation links automatically during CI.
Tech stack
lua
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80