Skip to content

ci: add link checking with mdbook-linkcheck and lychee#708

Merged
bug-ops merged 1 commit intomainfrom
ci/link-checking
Feb 21, 2026
Merged

ci: add link checking with mdbook-linkcheck and lychee#708
bug-ops merged 1 commit intomainfrom
ci/link-checking

Conversation

@bug-ops
Copy link
Owner

@bug-ops bug-ops commented Feb 21, 2026

Summary

  • mdbook-linkcheck in book.toml — validates internal links between doc pages during mdbook build (fails build on broken links)
  • lychee as separate CI job — checks links in README.md, crate READMEs, and all docs markdown files (offline mode, no external HTTP requests)
  • .lychee.toml config with exclusions for badge URLs and external services
  • Docs workflow now triggers on README changes too

How it works

Tool Scope When
mdbook-linkcheck Internal doc links (page-to-page) mdbook build step
lychee All markdown files (README + docs) Parallel job in docs workflow

Test plan

  • Docs build passes with linkcheck enabled
  • Lychee job runs and catches broken links
  • .lychee.toml excludes badge/external URLs to avoid false positives

@bug-ops bug-ops force-pushed the ci/link-checking branch 6 times, most recently from 9a3af55 to d0d4139 Compare February 21, 2026 12:23
- Add mdbook-linkcheck to docs build for internal link validation
- Add lychee job to docs workflow for README and markdown link checking
- Add .lychee.toml with exclusions for badge URLs and external services
- Trigger docs workflow on README changes
@bug-ops bug-ops enabled auto-merge (squash) February 21, 2026 12:26
@bug-ops bug-ops merged commit 88cc62a into main Feb 21, 2026
29 checks passed
@bug-ops bug-ops deleted the ci/link-checking branch February 21, 2026 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant