docs: standardize terminology for environment variables#5626
Merged
chenjiahan merged 1 commit intomainfrom Jul 18, 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 standardizes terminology across the Rsbuild codebase and documentation by consistently using "environment variables" instead of "env variables". Additionally, it adds a reference to the complete preset type definitions in the TypeScript documentation.
- Replaces all instances of "env variables" with "environment variables" throughout documentation and code comments
- Adds reference links to complete preset type definitions in TypeScript documentation (both English and Chinese)
- Updates section headings and titles to use the standardized terminology
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/guide/basic/typescript.mdx | Added reference to complete type definitions |
| website/docs/en/guide/migration/cra.mdx | Updated section heading from "Env variables" to "Environment variables" |
| website/docs/en/guide/debug/rsdoctor.mdx | Standardized terminology in Rsdoctor setup instructions |
| website/docs/en/guide/basic/typescript.mdx | Added reference to complete type definitions |
| website/docs/en/guide/advanced/env-vars.mdx | Comprehensive terminology updates throughout environment variables guide |
| website/docs/en/config/server/open.mdx | Updated terminology in browser configuration documentation |
| website/docs/en/api/javascript-api/core.mdx | Updated terminology in API documentation and type definitions |
| packages/core/src/types/rsbuild.ts | Updated TypeScript type comment |
| packages/core/src/loadEnv.ts | Updated TypeScript type comments for LoadEnvResult |
| packages/core/src/createRsbuild.ts | Updated inline code comment |
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
Checklist