engineering-handbook/lychee.toml
Adam Moussa 9c65fcb053
Some checks failed
ci / ci / ci (push) Has been cancelled
ci: add markdown-lint and link-check CI (INFRA-128) (#16)
Add a standalone ci workflow so handbook changes get an automated gate.
The job is named literally "ci / ci" to emit the exact status context the
org main-branch-protection ruleset requires.

- markdownlint-cli2 (.markdownlint-cli2.jsonc): MD013/MD060/MD040 relaxed
  as noisy docs-style rules; fixed 3 MD032 blank-line-around-list issues.
- lychee link check (lychee.toml): internal + external links, tolerates 429.
2026-07-08 16:20:28 -04:00

20 lines
686 B
TOML

# lychee link-checker config for the engineering handbook.
# Used by CI (lychee-action in .github/workflows/ci.yaml) and reproducible
# locally with:
# docker run --rm -v "$PWD:/input" lycheeverse/lychee \
# --config /input/lychee.toml /input/**/*.md
# Cache results between runs to cut repeat network calls.
cache = true
# Retry transient failures before giving up.
max_retries = 2
retry_wait_time = 2
timeout = 20
# Treat 2xx as success and tolerate 429 (rate-limited) so external flakiness
# never reds an otherwise-valid docs change. Broken internal links still fail.
accept = ["200..=299", "429"]
# Don't traverse dependency dirs.
exclude_path = ["node_modules", ".git"]