getodk / getodk/docs

Check for broken links automatically and fail build if there are broken links

Open
#1,766 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

https://github.com/raviqqe/muffet seems to be a good solution

`muffet --buffer-size 16384 https://docs.getodk.org --exclude "data.getodk.cloud"`

Contributor guide

Open the contributing guide

Research direction

Start by locating the Sphinx build configuration and CI entry point for this documentation repository. Run `muffet --buffer-size 16384 https://docs.getodk.org --exclude "data.getodk.cloud"` to verify the proposed check, then make the automated build fail when broken links are found.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, shell
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.