cozy / cozy/cozy.github.io

Automatically detect dead links

Open
#160 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
88
Forks
47
PR merge metrics
No merged PRs in 30d

Description

We regularly encounter dead links in the doc that we manually fix, like here.
It would be nice to have a tool periodically run to detect those dead links, like this one

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation repository and the linked broken-link-checker project to determine how link checks could run periodically. Define the check's scope and the report or failure behavior, with completion shown by regularly detecting dead documentation links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.