docs(agents): require lychee local-run on every PR — added to Before submitting#411
Merged
Merged
Conversation
…submitting Caught a Fragment-not-found regression in PR apache#410 only when CI flagged it. The check is cheap to run locally (offline file + fragment lookups; only the external-URL subset hits the network) and catching it before the push avoids a round-trip. Add to the Before-submitting checklist: - the canonical invocation (lychee --config .lychee.toml .) - guidance on the most common breakage class (Fragment not found) which is what bites on doc refactors that move sections between files or rename headings - a one-liner for v0.24+ local lychee installations (since .lychee.toml pins the v0.23 schema) The rule is enforce-via-CI either way (the lychee workflow blocks the merge on any failure); this is just a documentation reminder so agents add it to their pre-push routine and avoid the round-trip.
…n.yml The "Before submitting" lychee guidance pointed at `.github/workflows/doc-validation.yml`, which does not exist — this repo's link-check workflow is `link-check.yml`. Caught by running lychee on the same file the PR added (which is what the new rule itself prescribes).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a Before-submitting checklist entry that requires running `lychee --config .lychee.toml .` locally on every PR. Caught a Fragment-not-found regression in PR #410 only after CI flagged it; the check is cheap to run locally and catching it before the push avoids a round-trip.
Change
Append to the existing Before submitting checklist in `AGENTS.md`:
The rule is enforced by CI either way (the lychee workflow blocks merge on any failure); this just makes the local check a documented pre-push habit so agents avoid the CI round-trip.
Test plan
🤖 Generated with Claude Code