docs: improve docs for worker custom syntax#13552
Conversation
|
@codex review |
Deploying rspack with
|
| Latest commit: |
14354c3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://52b373d1.rspack-v2.pages.dev |
| Branch Preview URL: | https://worker-custom-syntax-doc.rspack-v2.pages.dev |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b5a99a51da
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
Pull request overview
This PR updates the Web Workers documentation to better explain Rspack’s worker-related syntax parsing, especially around custom worker-like syntax patterns.
Changes:
- Added a warning callout describing static-analysis limitations and unsupported magic comments.
- Reorganized the guide into “Built-in syntax” and “Custom syntax”, expanding explanations and examples (including Worklet cases like AudioWorklet).
- Updated built-in examples (e.g.,
worker_threadsimport source andserviceWorker.registerargument form).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
website/docs/en/guide/features/web-workers.mdx |
Expands and restructures worker syntax docs, including detailed custom syntax rules and examples. |
website/docs/zh/guide/features/web-workers.mdx |
Same as EN, with corresponding Chinese content updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Codex Review: Didn't find any major issues. Can't wait for the next one! ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
Summary
Improve docs based on feedback #13174
Related links
Checklist