Skip to content

docs: add lychee config cleanup note for lint:links adopters#61

Merged
zeitlinger merged 3 commits intomainfrom
doc-lychee-cleanup
Mar 2, 2026
Merged

docs: add lychee config cleanup note for lint:links adopters#61
zeitlinger merged 3 commits intomainfrom
doc-lychee-cleanup

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Summary

Add a "Lychee config cleanup" section to the lint:links docs listing which lychee.toml entries 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

  • GitHub blob remap workaround for lychee#1729
  • #issuecomment-* excludes
  • #L\d+ line-number anchor excludes

Copilot AI review requested due to automatic review settings February 24, 2026 07:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 --remap instead of --exclude

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
@zeitlinger zeitlinger merged commit 5df593a into main Mar 2, 2026
8 checks passed
@zeitlinger zeitlinger deleted the doc-lychee-cleanup branch March 2, 2026 17:58
This was referenced Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants