docs: clarify dts.build requirement#1482
Merged
Timeless0911 merged 2 commits intomainfrom Feb 12, 2026
Merged
Conversation
dts.build requirement
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies documentation for the dts.build option to note it only works when declaration bundling is disabled (dts.bundle = false), aligning user guidance with actual plugin behavior.
Changes:
- Add a note in EN docs that
dts.buildcan only be used whendts.bundleisfalse. - Add the same clarification in ZH docs.
- Update
rsbuild-plugin-dtsREADME to include the same restriction and reminder aboutdeclarationDir/outDir.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/docs/zh/config/lib/dts.mdx | Adds a ZH note that dts.build requires dts.bundle = false and reiterates tsconfig output dir requirements. |
| website/docs/en/config/lib/dts.mdx | Adds an EN note that dts.build requires dts.bundle = false and reiterates tsconfig output dir requirements. |
| packages/plugin-dts/README.md | Documents that build is only valid when bundle is false, plus tsconfig output dir requirement. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fi3ework
approved these changes
Feb 12, 2026
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
Clarify that the
dts.buildoption only works whendts.bundleisfalse.Related Links
Checklist