Skip to content

docs: fix broken links and stale controller names#9610

Open
ZayanKhan-12 wants to merge 1 commit into
MetaMask:mainfrom
ZayanKhan-12:fix-broken-doc-links
Open

docs: fix broken links and stale controller names#9610
ZayanKhan-12 wants to merge 1 commit into
MetaMask:mainfrom
ZayanKhan-12:fix-broken-doc-links

Conversation

@ZayanKhan-12

@ZayanKhan-12 ZayanKhan-12 commented Jul 22, 2026

Copy link
Copy Markdown

Explanation

A mechanical link audit of every markdown file in the repo (resolving each relative link target against the filesystem) found 12 broken links across 5 files. Docs-only change; no code touched.

packages/assets-controllers/README.md

  • The controller list still names CollectibleDetectionController and CollectiblesController, which were renamed to NftDetectionController / NftController long ago — both links 404. Updated the names and links, and moved the two entries so the list stays alphabetical.
  • DeFiPositionsController.ts.ts double-extension typo in the link target.
  • ./REAL_TIME_BALANCE_UPDATES.md doesn't exist; the doc lives at packages/core-backend/docs/real-time-balance-updates-flow.md.

packages/core-backend/docs/real-time-balance-updates-flow.md

  • The five links in "Related files" were written relative to the repo root (../packages/...), so they resolve to nonexistent paths from the file's directory. Also, AccountActivityService.ts and BackendWebSocketService.ts live under src/ws/, not src/.

packages/transaction-pay-controller/ARCHITECTURE.md/packages/... absolute path doesn't resolve on GitHub → ./src/utils/required-tokens.ts.

packages/permission-controller/ARCHITECTURE.md./PermissionController.test.ts./src/PermissionController.test.ts.

.cursor/BUGBOT.md./AGENTS.md../AGENTS.md (AGENTS.md is at the repo root).

References

N/A — found via link audit, no tracking issue.

Changelog

Docs-only; no consumer-facing package behavior change, so no changelog entries added. Happy to add them if preferred.

Checklist

  • I've updated the test suite for new or updated code as appropriate — N/A, docs only
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed — N/A, docs only
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes — N/A

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes with no impact on application behavior, APIs, or security-sensitive code paths.

Overview
Documentation-only fixes from a markdown link audit: 12 broken links across five files, with no runtime or package code changes.

In packages/assets-controllers/README.md, the controller list now uses NftController / NftDetectionController (replacing stale Collectibles names), fixes the DeFiPositionsController.ts.ts typo, and points the real-time balance doc at ../core-backend/docs/real-time-balance-updates-flow.md.

packages/core-backend/docs/real-time-balance-updates-flow.md “References” links are corrected to paths relative to that file, including src/ws/ for WebSocket services. permission-controller and transaction-pay-controller ARCHITECTURE docs use ./src/... instead of wrong root paths. .cursor/BUGBOT.md now links to ../AGENTS.md at the repo root.

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

- assets-controllers README: CollectibleDetectionController and
  CollectiblesController were renamed to NftDetectionController and
  NftController long ago; update the entries (and keep the list
  alphabetical), fix a DeFiPositionsController.ts.ts double-extension
  typo, and point the Real-Time Balance Updates link at the doc's
  actual location in core-backend/docs.
- core-backend real-time-balance-updates-flow doc: links were written
  relative to the repo root instead of the file's directory.
- transaction-pay-controller ARCHITECTURE: absolute /packages/... path
  doesn't resolve on GitHub.
- permission-controller ARCHITECTURE: PermissionController.test.ts
  lives in src/.
- .cursor/BUGBOT.md: AGENTS.md is at the repo root.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ZayanKhan-12
ZayanKhan-12 requested review from a team as code owners July 22, 2026 16:14
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