numpy / numpy/numpy.org

Add a link checker in CI to avoid broken links

Open
#254 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

deployment sprintable
Dominant language
Shell
Stars
128
Forks
132
Avg merge
1d 18h
Merged PRs (30d)
3

Description

This is a follow-up to gh-232. Getting a link checker to work with Hugo isn't completely trivial, but should be doable in CI. See https://discourse.gohugo.io/t/link-checker-for-go-hugo/2202/18

Contributor guide

Open the contributing guide

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 reading gh-232 and the linked Hugo discussion to understand the proposed link-checking approach. Then inspect the repository's CI configuration and determine how it builds the Hugo site. Done means CI reports broken links reliably without preventing valid site builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.