-
Notifications
You must be signed in to change notification settings - Fork 0
Fix link checker CI by excluding Fumadocs framework patterns #359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Updates Lychee configuration to avoid false positives from Fumadocs metadata/routing patterns that Lychee interprets as broken local file links during CI.
Changes:
- Added ignore patterns for Fumadocs
meta.json/meta.cn.json. - Added workflow-level
--exclude-pathrules for Fumadocs meta files. - Excluded
file://checks undercontent/docsto skip Fumadocs runtime-resolved relative links.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
lychee.toml |
Adds a broad file://**/content/docs/** exclusion intended to suppress Fumadocs runtime route false positives. |
.lycheeignore |
Adds ignore globs for meta.json and meta.cn.json. |
.github/workflows/check-links.yml |
Adds --exclude-path flags for meta files in the Lychee CI invocation. |
| # Fumadocs relative links (handled by framework at runtime) | ||
| # These are links like ./agent that resolve to .mdx files | ||
| "file://**/content/docs/**" |
Copilot
AI
Jan 28, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new exclude pattern file://**/content/docs/** is very broad and will match all file:// URLs under content/docs (including the remapped /docs/... links that this config is intended to validate). That likely disables internal doc link validation entirely and leaves only external HTTP/HTTPS checks. Consider narrowing this to only the problematic extensionless routes (e.g., links that don’t end with .md/.mdx) or adding a remap strategy that appends .mdx/.md for Fumadocs-style ./agent routes, so existing internal link checks remain effective.
| --exclude-path '**/meta.json' | ||
| --exclude-path '**/meta.cn.json' |
Copilot
AI
Jan 28, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--exclude-path '**/meta.json' / --exclude-path '**/meta.cn.json' appear redundant with the current invocation because the inputs being scanned are only content/**/*.md, content/**/*.mdx, and README.md (so no meta*.json files are included). If the intent is to prevent lychee from parsing those JSON files, either remove these flags for clarity or broaden the input globs to include the JSON files and keep the excludes.
| --exclude-path '**/meta.json' | |
| --exclude-path '**/meta.cn.json' |
Lychee link checker was failing with 272 errors because it treated Fumadocs framework files and routing patterns as broken file paths.
Fumadocs uses
meta.jsonfiles containing page identifiers ("agent","orchestration") and relative links (./agent) that resolve to.mdxfiles at runtime. Lychee attempted to validate these asfile://paths without extensions.Changes
.lycheeignore: Added**/meta.jsonand**/meta.cn.jsonpatternscheck-links.yml: Added explicit--exclude-pathflags for meta fileslychee.toml: Excludedfile://**/content/docs/**pattern to skip Fumadocs relative linksExternal HTTP/HTTPS link checking remains unchanged.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.