CI: scheduled link check for the course content
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 1
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 7
Description
Check that links in the course content still resolve — on a schedule, not only on pull requests.
The content links heavily to Nextcloud documentation, GitHub repos and external tools. Those rot without anyone touching this repository, so a PR-triggered check would never catch it. A weekly cron would.
For a tutorial, a dead link is a real defect: it is often the reader's next step.
Scope
lychee (or equivalent) over content/**/*.md and the README, on a weekly schedule plus manual dispatch. Report failures somewhere that gets noticed — an issue, ideally, rather than a silently red run.
Watch out
Some links will be flaky rather than dead (rate limits, sites blocking CI). Expect to need an ignore list, or failures will be routinely dismissed.
Part of #38.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names content/**/*.md and the README as link-check inputs; start by inspecting the repository's existing CI workflow setup and how scheduled and manual workflows are configured. Add a weekly and manually runnable check using lychee or an equivalent, with an ignore list and visible failure reporting. Done means link failures are noticed without a pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100