Skip to content

Conversation

@mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Jan 14, 2026

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.

  • Move configuration to lychee.toml
  • Consolidate excludes into lychee.toml
  • Exclude non-docs directories like .github and scripts
  • Move some logic from Action steps to the actual scripts
  • Prod check updates:
    • Now parses the sitemap to find pages to check.
    • Now also checks internal links since it's very fast.
  • PR check updates:
    • Now checks only files that the PR updates
    • Now leaves a PR comment with the results
    • No longer actually fails the PR, in case the broken link is temporary
    • Now works in forks with a small reduction in functionality: In a fork PR that adds a new page, internal links into that new page will show as broken. The PR comment hints about this.
    • Now warns about redirects caused by trailing / in internal links
  • Fixed some broken links:
    • Weave core-types pages that use relative links with the wrong number of ../s
    • Links with trailing / in the main index.mdx which cause an unnecessary redirect.

Testing

@mdlinville mdlinville changed the title Update Lychee link check actions crawl Update Lychee link check actions to support crawling Jan 14, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 14, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (3 total)

📄 Pages (3)

File Preview
index.mdx .
weave/guides/integrations/notdiamond.mdx Notdiamond
weave/reference/generated_typescript_docs/intro-notebook.mdx Intro Notebook

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: cf490a0 at 2026-01-16 18:11:33 UTC

@mdlinville mdlinville marked this pull request as ready for review January 14, 2026 01:09
@mdlinville mdlinville requested a review from a team as a code owner January 14, 2026 01:09
@mdlinville mdlinville changed the title Update Lychee link check actions to support crawling [DOCS-1988] Update Lychee link check actions to support crawling Jan 14, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 14, 2026

🔗 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:

  • https://docs.wandb.ai/models/https://docs.wandb.ai/models

Fix: Remove trailing slashes from links to avoid unnecessary redirects.

@mdlinville mdlinville enabled auto-merge (squash) January 16, 2026 18:12
@mdlinville mdlinville merged commit e4ff523 into main Jan 16, 2026
7 checks passed
@mdlinville mdlinville deleted the lychee_crawling_support branch January 16, 2026 18:13
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.

3 participants