[docs-agent] Fix 41 broken links flagged by weekly link check#1330
Open
alchemy-bot wants to merge 1 commit into
Open
[docs-agent] Fix 41 broken links flagged by weekly link check#1330alchemy-bot wants to merge 1 commit into
alchemy-bot wants to merge 1 commit into
Conversation
All 41 broken links live on domains we control (alchemy.com and github.com/alchemyplatform/aa-sdk):
* 34 links pointed at /docs/wallets/reference/{account-kit,aa-sdk}/... — those autogenerated SDK reference pages were removed from the live docs site when wallet-apis v5 graduated to GA. The v4 SDK reference content was preserved in the aa-sdk repo on the 'v4.x.x' branch under 'docs/pages/reference/...', so each broken link is repointed at the corresponding source MDX on that branch (hooks live in functions/, since TypeDoc emits hooks as functions; package roots use tree/ links).
* 7 links pointed at github.com/alchemyplatform/aa-sdk/{blob,tree}/main/account-kit/... or examples/... — aa-sdk v5 graduated to main on 2026-05-20 (aa-sdk#2523, aa-sdk#2527), so those paths now only exist on the v4.x.x branch. Switched main → v4.x.x on each.
Touches 21 MDX files in content/wallets/. While editing each file, also swept it for additional instances of the same broken URLs (lychee deduplicates per file, but the next run would flag them anyway) so each touched file is fully clean.
Refs DOCS-98
🔗 Preview Mode
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 2026-05-25 weekly Link Check workflow flagged 41 broken links (run 26412686252). All 41 land on domains we control (
alchemy.comandgithub.com/alchemyplatform/aa-sdk), so the right fix is to repoint each one.Two underlying causes:
https://www.alchemy.com/docs/wallets/reference/{account-kit,aa-sdk}/...— the autogenerated v4 SDK reference site at those URLs is gone from the live docs (only/docs/wallets/reference/wallet-apis/...remains, for v5). The v4 reference content was preserved in theaa-sdkrepo on thev4.x.xbranch underdocs/pages/reference/..., so each link is repointed at the matching source MDX on that branch. Hooks live infunctions/(TypeDoc emits hooks as functions); package roots usetree/URLs.https://github.com/alchemyplatform/aa-sdk/{blob,tree}/main/{account-kit,examples}/...—aa-sdkv5 graduated tomainon 2026-05-20 (aa-sdk#2523, aa-sdk#2527), so the legacyaccount-kit/...andexamples/...trees only exist onv4.x.xnow. Switchedmain→v4.x.xon each.Mapping pattern
https://www.alchemy.com/docs/wallets/reference/<pkg>/<sub>/<category>/<name>becomeshttps://github.com/alchemyplatform/aa-sdk/blob/v4.x.x/docs/pages/reference/<pkg>/<sub>/src/<category>/<name>.mdx, withhooks/<name>→functions/<name>.mdx. Every target path was verified to return 200 before pushing.Files touched (21)
content/wallets/pages/concepts/middleware.mdx,content/wallets/pages/core/overview.mdx,content/wallets/pages/low-level-infra/third-party-infrastructure/bundlers.mdx,content/wallets/pages/low-level-infra/third-party-infrastructure/chains.mdx,content/wallets/pages/react-native/overview.mdx,content/wallets/pages/react/customization/theme.mdx,content/wallets/pages/react/getting-started/initialization.mdx,content/wallets/pages/react/login-methods/eoa-login.mdx,content/wallets/pages/react/login-methods/passkey-login.mdx,content/wallets/pages/react/login-methods/social-providers.mdx,content/wallets/pages/react/solana-wallets/get-started.mdx,content/wallets/pages/react/ui-components.mdx,content/wallets/pages/recipes/hyperliquid-wallets.mdx,content/wallets/pages/recipes/multi-chain-setup.mdx,content/wallets/pages/recipes/smart-wallets-aave.mdx,content/wallets/pages/resources/faqs.mdx,content/wallets/pages/resources/types.mdx,content/wallets/pages/signer/export-private-key.mdx,content/wallets/pages/signer/user-sessions.mdx,content/wallets/pages/smart-wallets/how-to-stamp-requests.mdx,content/wallets/shared/react-native/signer-setup.mdx.While editing each file I also swept it for additional instances of the same broken URLs (lychee deduplicates per file, but the next run would flag the duplicates anyway), so each touched file is fully clean afterwards.
Why GitHub source instead of redirects
content/redirects.ymlcarries an explicit note (line ~2419) warning against adding wildcard redirects for/docs/wallets/reference/account-kit/paths because they used to be served from a separate SDK index. That comment is stale (the SDK index is gone), but adding wildcard redirects across the entire reference tree is broader scope than this PR. Pointing each link at the equivalentv4.x.xsource page on GitHub is precise per-link, surfaces the content where it currently lives, and doesn't conflict with any future global redirect decision.Not in scope
content/wallets/pages/authentication/login-methods/bring-your-own-auth.mdx,content/wallets/pages/smart-wallets/session-keys/api.mdx, andcontent/wallets/shared/setup-smart-account-client/smart-account-client-details.mdxall contain similar dead/wallets/reference/...URLs that the weekly check did NOT flag this run. Leaving them for the next link-check cycle to surface deliberately, so this PR stays scoped to the 41-link report.Linear
DOCS-98 — Fix 41 broken links from weekly link check
Slack thread
Triggered by the weekly Link Check job posting in #dx-developer-relations (thread
1779730908.495629).