docs: clarify unsupported options in environments config#6498
Merged
chenjiahan merged 1 commit intomainfrom Nov 4, 2025
Merged
docs: clarify unsupported options in environments config#6498chenjiahan merged 1 commit intomainfrom
chenjiahan merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the environments configuration option in both English and Chinese versions. The changes improve clarity by replacing a detailed TypeScript interface definition with a more concise explanation of available options.
Key Changes:
- Removed the verbose
EnvironmentConfigTypeScript interface from the documentation - Added a new "Available options" section that explains
EnvironmentConfigas a subset of Rsbuild configuration - Replaced the general tip about unsupported options with a specific list of unsupported configuration keys
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/en/config/environments.mdx | Updated English documentation to replace interface definition with a clear list of unsupported options |
| website/docs/zh/config/environments.mdx | Updated Chinese documentation with the same structural improvements as the English version |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Remove verbose
environmentsinterface definition and explicitly list unsupported options in docs.The change makes it clearer which configurations cannot be used with multiple environments due to shared server instance constraints.
Checklist