-
Notifications
You must be signed in to change notification settings - Fork 40
[DOCS-1988] Update Lychee link check actions to support crawling #2037
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
📚 Mintlify Preview Links📝 Changed (3 total)📄 Pages (3)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker Results✅ All links are valid! No broken links were detected in the changed files. Tip Redirects detected: If you see redirects for internal docs.wandb.ai links, check if they have trailing slashes. Mintlify automatically removes trailing slashes, causing redirects like:
Fix: Remove trailing slashes from links to avoid unnecessary redirects. |
71f8e36 to
d2f53e5
Compare
Also sort each list in the TOML alphabetically for maintenance
…chee_crawling_support
Description
Fixes DOCS-1988
David F on CoreWeave docs team discovered that Lychee does not crawl recursively by default. This means that in both PRs and production, we were only checking the site index for broken http:// and https:// links. This PR fixes that and makes other improvements.
lychee.tomllychee.toml.githubandscripts/in internal links../s/in the mainindex.mdxwhich cause an unnecessary redirect.Testing
Prod: Tested in my fork (see https://github.com/mdlinville/docs/actions/runs/21009619899). Checked 1134 links in 24 secxonds.
PR: Tested in my fork (see https://github.com/mdlinville/docs/actions/runs/21011598457 and Break a link to test the PR action mdlinville/docs#63 (comment)). Took 44 seconds to check links in 16 changed files.
Local build succeeds without errors (
mint dev)Local link check succeeds without errors (
mint broken-links)PR tests succeed