docs: add lychee config cleanup note for lint:links adopters#61
Merged
zeitlinger merged 3 commits intomainfrom Mar 2, 2026
Merged
docs: add lychee config cleanup note for lint:links adopters#61zeitlinger merged 3 commits intomainfrom
zeitlinger merged 3 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a "Lychee config cleanup" section to the lint:links documentation to help adopters understand which lychee.toml configuration entries they can safely remove when adopting flint. The documentation clarifies that flint handles certain URL patterns (GitHub blob remaps, issue comment anchors, and line-number anchors) at runtime via --remap arguments, eliminating the need for these configurations in the lychee config file.
Changes:
- Adds a "Lychee config cleanup" subsection explaining which lychee.toml entries can be removed
- Documents three specific patterns that flint handles: GitHub blob remap for lychee#1729,
#issuecomment-*excludes, and#L\d+line-number excludes - Includes a note explaining why flint uses
--remapinstead of--exclude
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Apr 16, 2026
Closed
Closed
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
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 "Lychee config cleanup" section to the
lint:linksdocs listing whichlychee.tomlentries can be removed when adopting flint, because flint handles them at runtime via--remap.Motivation: When adopting flint in opentelemetry-java-instrumentation#16270, I initially kept (and even added) lychee config entries that flint already handles — the existing docs explain what flint does but don't explicitly tell adopters what they can remove from their lychee config.
Entries documented for removal
#issuecomment-*excludes#L\d+line-number anchor excludes