lychee.toml

# lychee link-checker config
# See https://github.com/lycheeverse/lychee for all options.

# Only run internal (offline) checks in CI — external checks are too flaky
# for a prose guide full of third-party references.
# (The CI workflow passes --offline; this file just documents intent.)

# Paths that contain placeholder / template links that are valid in a user's
# actual setup but not in this repo. Lychee treats these as broken, so exclude them.
exclude_path = [
  "templates/",
]

# Ignore specific URL patterns we know are placeholders or ephemeral.
exclude = [
  # Auto-generated session URLs in PR descriptions / examples
  "^https://app\\.devin\\.ai/sessions/",
  # Common placeholder URLs in example configs
  "^https://example\\.com",
]

# Fragment checks stay on lychee's default. The config key changed shape between
# lychee 0.23 and 0.24, so setting it here breaks one of those versions.