Skip to content

docs: fix broken external links (#20)#22

Merged
alexander-sei merged 1 commit into
mainfrom
docs/fix-broken-external-links-issue-20
Jun 4, 2026
Merged

docs: fix broken external links (#20)#22
alexander-sei merged 1 commit into
mainfrom
docs/fix-broken-external-links-issue-20

Conversation

@alexander-sei
Copy link
Copy Markdown
Collaborator

What is the purpose of the change?

Correct existing documentation. Resolves the 23 broken external links flagged by the weekly lychee check in #20.

Describe the changes to the documentation

The errors fall into two categories:

Genuinely dead links — repointed to live, verified targets:

  • ai/x402.mdx — the entire sei-js.docs.sei.io subdomain was decommissioned (it now 301-redirects to docs.sei.io, and the x402 pages were not migrated there), so all 12 links 404'd.
    • The 6 package links now point to their npm pages (@sei-js/x402, -fetch, -axios, -express, -hono, -next — all confirmed published).
    • The overview / quickstart / facilitators / client-integration links now point to the canonical sei-protocol/sei-x402 repo docs, where these packages now live.
  • evm/usdc-on-sei.mdx — the Replit CCTP template 404'd, and the older circlefin/cctp-sample-app is archived. Repointed to Circle's actively-maintained circlefin/circle-cctp-crosschain-transfer sample app.

False positives — handled in lychee.toml (these sites are alive; they just block automated checkers):

  • Added 405 to accepted status codes. JSON-RPC endpoints like evm-rpc.sei-apis.com reject the checker's GET with 405 but are very much alive (405 = "alive, wrong method", never link rot). This clears the 405 errors across 7 files.
  • Excluded silostaking.io (returns 402 to bots), dashboard.pimlico.io (returns 404 to bots — client-rendered app shell), and blog.thirdweb.com (valid cert in browsers, but lychee's TLS client rejects the chain). Each is documented with a comment, and the excludes are host-specific so nearby links such as silostaking.gitbook.io are still checked.

Notes

  • Verified locally with lychee 0.24.2 using the updated config against all 13 previously-failing files: 0 errors (108 OK, 43 excluded as intended).
  • llms-full.txt still contains the old URLs, but it is a generated artifact (built from the live site by scripts/generate-llms.mjs), is not scanned by lychee (*.md/*.mdx only), and refreshes automatically via the weekly regenerate workflow once these edits deploy — so no hand-editing is needed.

🤖 Generated with Claude Code

Resolves the 23 broken-link errors flagged by the weekly lychee check.

Genuinely dead links, repointed to live targets:
- ai/x402.mdx: the sei-js.docs.sei.io subdomain was decommissioned (now
  301s to docs.sei.io without the x402 pages). Repoint the 6 package links
  to their npm pages and the concept links to the canonical
  sei-protocol/sei-x402 repo docs.
- evm/usdc-on-sei.mdx: the Replit CCTP template 404s; repoint to Circle's
  maintained circlefin/circle-cctp-crosschain-transfer sample app.

False positives (live sites that block automated checkers), handled in
lychee.toml:
- Accept 405 for JSON-RPC endpoints like evm-rpc.sei-apis.com that reject
  the checker's GET but are alive.
- Exclude silostaking.io (402 to bots), dashboard.pimlico.io (404 to bots),
  and blog.thirdweb.com (cert chain lychee's TLS rejects).

Verified with lychee 0.24.2 against all previously-failing files: 0 errors.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@cursor
Copy link
Copy Markdown

cursor Bot commented Jun 3, 2026

PR Summary

Low Risk
Documentation and link-checker configuration only; no application code, auth, or data paths change.

Overview
Fixes broken external links flagged by the weekly lychee job by updating doc targets and tuning the link checker so live URLs are not reported as rot.

In ai/x402.mdx, all references to the decommissioned sei-js.docs.sei.io site are repointed: conceptual links go to sei-protocol/sei-x402 on GitHub, and package links go to the published @sei-js/x402* npm packages. In evm/usdc-on-sei.mdx, the dead Replit CCTP link is replaced with Circle’s maintained circle-cctp-crosschain-transfer sample repo.

lychee.toml now treats 405 as acceptable (e.g. JSON-RPC URLs that reject GET), and excludes a few hosts that block bots or fail TLS in the checker but work in browsers (silostaking.io, dashboard.pimlico.io, blog.thirdweb.com), with inline comments explaining each.

Reviewed by Cursor Bugbot for commit 579e8af. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
sei-docs 🟢 Ready View Preview Jun 3, 2026, 11:52 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@alexander-sei alexander-sei merged commit a775b4f into main Jun 4, 2026
10 checks passed
@alexander-sei alexander-sei deleted the docs/fix-broken-external-links-issue-20 branch June 4, 2026 12:54
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.

1 participant