docs: update proxy configuration examples#7123
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello @chenjiahan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the clarity and consistency of proxy configuration documentation by standardizing example URLs. It shifts the focus from local Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Deploying rsbuild with
|
| Latest commit: |
28b9591
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://82b200ff.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://proxy-examples-0203.rsbuild-v2.pages.dev |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the proxy configuration examples in the documentation to use remote targets like https://example.com for better clarity. The changes are consistent across both English and Chinese documentation. I've found a minor issue in one of the English examples where a proxy target URL seems to be incorrect, potentially leading to duplicated paths. I've left a suggestion to correct it. Overall, the changes improve the documentation.
There was a problem hiding this comment.
Pull request overview
This PR updates the proxy configuration documentation and examples to consistently demonstrate proxying to a remote domain (https://example.com and https://example.com/api) instead of local targets, and clarifies the distinction between remote and local backend examples.
Changes:
- Update upgrade guides (EN/ZH) for
http-proxy-middlewarev2→v3 to usehttps://example.com/apias the target in both object and array proxy configurations. - Refresh the main
server.proxyconfig docs (EN/ZH) to usehttps://example.com/apias the primary remote example, and reposition localhost examples as secondary/local-service scenarios. - Adjust related examples for path rewriting, WebSocket proxying, path filters, and
bypassbehavior to align with the new remote-domain focus.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
website/docs/zh/guide/upgrade/v1-to-v2.mdx |
Updates Chinese v1→v2 proxy migration examples to use https://example.com/api and pathFilter in line with the new remote-target guidance. |
website/docs/zh/config/server/proxy.mdx |
Revises Chinese server.proxy docs to introduce https://example.com/api as the canonical remote target and move localhost configurations into explicit “local service” examples. |
website/docs/en/guide/upgrade/v1-to-v2.mdx |
Updates English v1→v2 proxy migration examples to consistently use https://example.com/api and pathFilter, matching the new recommended pattern. |
website/docs/en/config/server/proxy.mdx |
Revises English server.proxy docs to focus on https://example.com/api for basic usage, adjust local-service examples, and update path rewrite, WebSocket, path filter, and bypass examples accordingly (with one WebSocket target inconsistency noted). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
Summary
Updates the proxy configuration examples and documentation to use
https://example.comandhttps://example.com/apias the primary remote targets instead of local addresses. The changes improve clarity by consistently demonstrating how to proxy requests to remote domains.Checklist