docs: clarify methods to access environment context#5335
Merged
chenjiahan merged 1 commit intomainfrom May 31, 2025
Merged
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 clarifies how to access the environment context by updating the documentation in both the Chinese and English versions.
- Updated the explanation to include two methods of accessing the environment context via Rsbuild's Plugin hooks and the Environment API.
- Modified type annotations to use a link reference for EnvironmentContext.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/zh/api/javascript-api/environment-api.mdx | Updated documentation text and list format for clearer guidance on accessing environment context. |
| website/docs/en/api/javascript-api/environment-api.mdx | Updated documentation text and list format for a clearer explanation of accessing environment context. |
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
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
Added two ways to access the environment context: via Rsbuild's plugin hooks and the Environment API, with corresponding links for better guidance.
Related Links
Checklist