Skip to content

docs(config): improve node options docs#12236

Merged
chenjiahan merged 3 commits intomainfrom
node_global_doc_1119
Nov 19, 2025
Merged

docs(config): improve node options docs#12236
chenjiahan merged 3 commits intomainfrom
node_global_doc_1119

Conversation

@chenjiahan
Copy link
Member

Summary

  • Enhance node.* documentation with clearer explanations, optional values, and usage examples.
  • Update license links in mode.mdx files to point to correct webpack documentation.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings November 19, 2025 06:47
@netlify
Copy link

netlify bot commented Nov 19, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit 3d28a6d
🔍 Latest deploy log https://app.netlify.com/projects/rspack/deploys/691d68d592f39800081f284b
😎 Deploy Preview https://deploy-preview-12236--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack. labels Nov 19, 2025
Copy link
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 enhances the documentation for Rspack's node.* configuration options by adding clearer explanations, improved formatting, and practical usage examples. It also fixes incorrect license links in mode.mdx files.

  • Adds detailed descriptions for node.global, node.__filename, and node.__dirname configuration options
  • Provides code examples demonstrating how to use each node configuration option
  • Corrects webpack documentation license links in mode.mdx files to point to the correct URL

Reviewed Changes

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

File Description
website/docs/en/config/node.mdx Improves type formatting, adds explanatory text for each node option, and includes practical code examples
website/docs/zh/config/node.mdx Mirrors English documentation improvements with Chinese translations and examples
website/docs/en/config/mode.mdx Fixes WebpackLicense link from node/ to mode/ documentation
website/docs/zh/config/mode.mdx Fixes WebpackLicense link from node/ to mode/ documentation

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

@chenjiahan chenjiahan requested a review from SyMind November 19, 2025 06:52
@chenjiahan chenjiahan enabled auto-merge (squash) November 19, 2025 06:57
@chenjiahan chenjiahan merged commit 29d7220 into main Nov 19, 2025
26 checks passed
@chenjiahan chenjiahan deleted the node_global_doc_1119 branch November 19, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants