docs: document retry policy for network errors - #150
Merged
Conversation
Closes #149 - Add a 'Retry Policy' section to the Network Errors troubleshooting page - Include an SVG-icon table listing which error types are retried and which are not (based on the logic in lychee-lib/src/retry.rs) - Document the --max-retries and --retry-wait-time options with their defaults (3 and 1s) - Add 'Connection reset by server' as an example error message - Minor wording improvements throughout
katrinafyi
reviewed
Mar 14, 2026
katrinafyi
left a comment
katrinafyi
left a comment
Member
There was a problem hiding this comment.
Looks good. I'm definitely not an expert on network error conditions, but the text looks fine and makes sense. I'm sure it will be helpful.
Co-authored-by: Kait <39479354+katrinafyi@users.noreply.github.com>
thomas-zahner
approved these changes
Mar 16, 2026
6 tasks
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
3 participants
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.
Closes #149
Summary
The network errors troubleshooting page previously had no information about whether lychee retries failed requests. This PR adds a dedicated Retry Policy section that answers the question from the issue.
Changes
## Retry Policysection with:lychee-lib/src/retry.rs### Configuring retriessub-section documenting--max-retries(default: 3) and--retry-wait-time(default: 1 s) with CLI and TOML examplesConnection reset by serveras an example error message (the exact error from the issue)