docs: add FAQ for declaration files directory structure#1446
Merged
Timeless0911 merged 1 commit intomainfrom Jan 21, 2026
Merged
docs: add FAQ for declaration files directory structure#1446Timeless0911 merged 1 commit intomainfrom
Timeless0911 merged 1 commit intomainfrom
Conversation
Deploying rslib with
|
| Latest commit: |
8dafd3c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fbbf059e.rslib.pages.dev |
| Branch Preview URL: | https://docs-faq-root-dir.rslib.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new FAQ item to both English and Chinese documentation explaining why TypeScript declaration files may have an unexpected directory structure and how to resolve it by explicitly setting the rootDir in tsconfig.json.
Changes:
- Added FAQ section explaining the relationship between
rootDirconfiguration and declaration file output structure - Included a practical example showing the problem when
compositeis set totrue - Provided a clear solution with JSON configuration example
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/en/guide/faq/features.mdx | Added English FAQ entry about declaration file directory structure |
| website/docs/zh/guide/faq/features.mdx | Added Chinese FAQ entry about declaration file directory structure (identical content to English version) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
✅ Deploy Preview for rslib ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
fi3ework
approved these changes
Jan 21, 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
Add a new FAQ item explaining why the directory structure of declaration files might not meet expectations and how to fix it using
rootDirintsconfig.json. Both English and Chinese versions are updated.Related Links
Checklist