docs: fix broken file links in package READMEs#4083
Open
ZayanKhan-12 wants to merge 1 commit into
Open
Conversation
- snaps-rollup-plugin and snaps-webpack-plugin READMEs link to ../utils/src/post-process.ts, but the package directory is packages/snaps-utils. - Seven example READMEs link to ./src/index.test.ts; the files are index.test.tsx. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Description
A mechanical link audit (resolving every relative markdown link against the filesystem) found 9 broken file links in package READMEs:
snaps-rollup-pluginandsnaps-webpack-pluginREADMEs link to../utils/src/post-process.tsfor the list of SES transforms, but the package directory ispackages/snaps-utils→../snaps-utils/src/post-process.tstransaction-insights,cronjobs,signature-insights,images,ethers-js,dialogs, andnotificationsexample READMEs link to./src/index.test.ts, but the test files are.tsx→./src/index.test.tsxLink targets only; no prose changes. After the change the audit reports zero broken relative links (excluding the intentional
link-to-prplaceholders in AGENTS.md/CLAUDE.md).🤖 Generated with Claude Code
Note
Low Risk
Documentation-only link path corrections with no runtime or build behavior changes.
Overview
Fixes nine broken relative markdown links in package READMEs so they resolve to real files.
Seven example snap READMEs (
cronjobs,dialogs,ethers-js,images,notifications,signature-insights,transaction-insights) now point end-to-end test links at./src/index.test.tsxinstead of the non-existent.tspath.The
@metamask/snaps-rollup-pluginand@metamask/snaps-webpack-pluginREADMEs now link SES post-process source at../snaps-utils/src/post-process.tsinstead of../utils/src/post-process.ts.Reviewed by Cursor Bugbot for commit f437e93. Bugbot is set up for automated code reviews on this repo. Configure here.