Skip to content

docs: clarify fast refresh README examples#105

Merged
chenjiahan merged 1 commit intomainfrom
chenjiahan/docs-readme-fast-refresh
Apr 8, 2026
Merged

docs: clarify fast refresh README examples#105
chenjiahan merged 1 commit intomainfrom
chenjiahan/docs-readme-fast-refresh

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

Summary

  • clarify that React Fast Refresh requires both runtime injection and source transformation
  • update the builtin:swc-loader example to use the broader extension pattern and detectSyntax: 'auto'
  • fix example links to point at the current rstack-examples repository

Related Links

  • None

Validation

  • pre-commit lint:write ran successfully during git commit

@chenjiahan chenjiahan marked this pull request as ready for review April 8, 2026 09:42
Copilot AI review requested due to automatic review settings April 8, 2026 09:42
@chenjiahan chenjiahan merged commit adb618d into main Apr 8, 2026
5 checks passed
@chenjiahan chenjiahan deleted the chenjiahan/docs-readme-fast-refresh branch April 8, 2026 09:42
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 updates the README to more clearly explain what’s required for React Fast Refresh when using @rspack/plugin-react-refresh, and refreshes the configuration/examples shown to match current guidance and repositories.

Changes:

  • Clarifies that Fast Refresh requires both runtime injection (handled by this plugin) and source transformation (handled by a loader).
  • Updates the builtin:swc-loader example to use a broader test pattern and detectSyntax: 'auto'.
  • Fixes example links to point at the current rstack-examples repository.

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

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.

2 participants