github-samples / github-samples/pets-workshop

Add markdown link-checker CI workflow

Open
#240 1 comment 0 reactions 1 assignee View on GitHub

@scubaninja is already working on this.

Since May 20, 2026.

priority: P1
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

Description

Need

No CI workflows exist (by design for the workshop). However, a workflow that validates markdown links in content PRs would catch link rot early.

Suggestion

  • Add a workflow triggered on PRs that touch content/** or *.md
  • Use an action like lycheeverse/lychee-action to check for broken links
  • Keep it lightweight so it doesn't interfere with workshop exercises

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.