lychee.toml

# External (outbound) link checking for the docs.
#
# Internal links are already validated at build time by starlight-links-validator
# (see .github/workflows/docs.yml). This config covers links that LEAVE the site —
# run by .github/workflows/external-link-check.yml on a weekly schedule (+ manual).

# --- Network behaviour ------------------------------------------------------
# External hosts are flaky; retry transient failures before reporting rot.
max_retries = 3
retry_wait_time = 2          # seconds between retries
timeout = 20                 # seconds per request

# A rate-limited response is transient, not a broken link.
accept = ["200..=299", "429"]

# Resolve root-relative internal links (e.g. /pangolin/...) against the site origin so
# lychee can BUILD them — otherwise it reports "cannot build URL" before any exclude
# filter applies. We then exclude the resolved internal prefix below, so this monitor
# stays OUTBOUND-only (internal links remain starlight-links-validator's job at build).
base_url = "https://quarrysystems.github.io"

# --- Scope ------------------------------------------------------------------
# Don't probe hosts that only make sense inside a deployment / example.
exclude_loopback = true      # 127.0.0.1, localhost
exclude_private = true       # RFC1918 ranges
exclude_link_local = true

# mailto:/tel: — we care about web link rot, not address reachability.
include_mail = false

# Links that are intentionally not GET-checkable here.
exclude = [
  # Our OWN site host (links resolved against base_url, intra-page #anchors, etc.) is
  # internal — already validated at build by starlight-links-validator. Skip the whole
  # host so this stays an outbound-only monitor.
  '^https://quarrysystems\.github\.io',
  # freetsa is an RFC 3161 timestamp endpoint — POST-only; a GET link-check is meaningless.
  '^https?://freetsa\.org/tsr',
  # Hostnames that appear only in config/example snippets, never real web targets.
  'host\.docker\.internal',
  '^https?://example\.(com|org)',
]

# --- Caching ----------------------------------------------------------------
# Speed up reruns; short TTL so rot is still caught within a week.
cache = true
max_cache_age = "2d"