docs: improve documentation for dts.alias
#1391
Merged
Conversation
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
✅ Deploy Preview for rslib 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 enhances the documentation for dts.alias configuration by clarifying how path aliases work and providing concrete examples of their behavior. The changes address issue #1390 by making the documentation more comprehensive and easier to understand.
Key Changes:
- Clarified that path aliases in
dts.aliasshould be relative tocompilerOptions.baseUrl - Added code examples demonstrating import path redirection behavior when
redirect.dts.pathis enabled
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 | Updated Chinese documentation with clarification about baseUrl and added redirection example |
| website/docs/en/config/lib/dts.mdx | Updated English documentation with clarification about baseUrl and added redirection example |
| packages/plugin-dts/README.md | Updated plugin README with clarification about baseUrl and added redirection example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
fi3ework
approved these changes
Dec 11, 2025
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
improve documentation for
dts.aliasRelated Links
close: #1390
Checklist