Skip to content

docs: Add links to Node.js API docs in various module replacements pages.#618

Merged
43081j merged 5 commits intoe18e:mainfrom
connorshea:improve-docs
Apr 19, 2026
Merged

docs: Add links to Node.js API docs in various module replacements pages.#618
43081j merged 5 commits intoe18e:mainfrom
connorshea:improve-docs

Conversation

@connorshea
Copy link
Copy Markdown
Contributor

🔗 Linked issue

N/A

📚 Description

This adds Node.js API docs links in various places where the native API is noted (and MDN in a few cases). Plus some minor, general improvements while I was going through the pages.

Also note in the md5 page that it is insecure and has been for a long time, with a link to the Wikipedia article.

…ges.

And some minor, general improvements otherwise.

Also note in the md5 page that is is insecure and has been for a long time.
Copilot AI review requested due to automatic review settings April 19, 2026 19:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the “module replacements” documentation by adding direct links to relevant Node.js (and some MDN) API docs, plus minor wording improvements to better guide readers toward native alternatives.

Changes:

  • Add/standardize links to Node.js API documentation across multiple replacement pages.
  • Add short explanatory text for certain replacements (e.g., through, split) to clarify intent/usage.
  • Add a stronger security note and reference link for MD5’s insecurity.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/modules/uuidv4.md Clarifies crypto.randomUUID availability (browser + Node.js).
docs/modules/through.md Adds a Node.js API doc link and a brief explanation for stream.Writable.
docs/modules/strip-ansi.md Adds a Node.js API doc link and formats the API name as code.
docs/modules/split.md Adds Node.js API doc link + explanatory text; updates example imports.
docs/modules/object-hash.md Links SubtleCrypto.digest to MDN docs.
docs/modules/md5.md Adds explicit insecurity warning + Wikipedia link; links Node crypto docs.
docs/modules/inherits.md Adds MDN link for extends.
docs/modules/get-stream.md Links Array.fromAsync to MDN and clarifies Node version note.
docs/modules/fs-extra.md Links fs and fs/promises to Node.js API docs.
docs/modules/builtin-modules.md Formats and links builtinModules to Node.js API docs.
docs/modules/buffer-equals.md Links Buffer#equals to Node.js API docs and clarifies version text.
docs/modules/buffer-equal.md Links Buffer#equals to Node.js API docs and clarifies version text.
docs/modules/buf-compare.md Links Buffer.compare to Node.js API docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/modules/split.md Outdated
Comment thread docs/modules/through.md Outdated
Comment thread docs/modules/md5.md Outdated
connorshea and others added 3 commits April 19, 2026 13:05
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread docs/modules/uuidv4.md Outdated
@43081j 43081j merged commit 58bf7ff into e18e:main Apr 19, 2026
4 checks passed
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.

3 participants