docs: remove broken links to deleted examples directory#1026
Open
mahmoodhamdi wants to merge 1 commit intodebug-js:masterfrom
Open
docs: remove broken links to deleted examples directory#1026mahmoodhamdi wants to merge 1 commit intodebug-js:masterfrom
mahmoodhamdi wants to merge 1 commit intodebug-js:masterfrom
Conversation
The README references example files in ./examples/node/ (app.js, worker.js, stdout.js) that no longer exist in the repository. The examples directory was removed and is not included in the package.json files field. Since the example code is already shown inline in the README, the dead links are unnecessary. Fixes debug-js#927
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.
What
Removed 3 broken hyperlinks in README.md that point to non-existent example files:
./examples/node/app.js./examples/node/worker.js./examples/node/stdout.jsThe link text is preserved (e.g.,
Example _app.js_:) — only the dead<a>targets are removed.Why
The
examples/directory was removed from the repository and is excluded from thepackage.jsonfilesfield. These links have been returning 404 for years. Since the example code is already shown inline in the README directly below each reference, the links serve no purpose.This is a minimal fix — just 3 lines changed, no content added or removed.
Testing
All existing tests pass. Documentation-only change.
Fixes #927