-
Notifications
You must be signed in to change notification settings - Fork 273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docs): fix the wrong filename #2510
Conversation
WalkthroughThe pull request introduces modifications to the documentation for integrating the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
[e2e-test-warn] The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug". Please make sure you've read our contributing guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
examples/sites/demos/pc/webdoc/import-components.md (2)
32-32
: LGTM! Consider adding a clarifying note about Vue CLI.The change to
vue.config.js
is correct as this is the standard configuration file for Vue CLI projects. Consider adding a note mentioning this is specifically for Vue CLI projects using Webpack.
Line range hint
161-178
: Enhance the pnpm dependency management section.While the explanation is accurate, consider these improvements:
- Add the English term "phantom dependencies" in parentheses after "幽灵依赖" for better international understanding
- Be more specific about version numbers in the JSON example, possibly adding a note about version compatibility
{ "dependencies": { - "@opentiny/vue-button": "~3.x.x", - "@opentiny/vue-alert": "~3.x.x", - "@opentiny/vue-input": "~3.x.x", + "@opentiny/vue-button": "~3.17.0", + "@opentiny/vue-alert": "~3.17.0", + "@opentiny/vue-input": "~3.17.0", ... } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
examples/sites/demos/pc/webdoc/import-components-en.md
(1 hunks)examples/sites/demos/pc/webdoc/import-components.md
(3 hunks)
🔇 Additional comments (4)
examples/sites/demos/pc/webdoc/import-components-en.md (3)
25-25
: LGTM: Explicit build tool specification improves clarity
The change to autoImportPlugin('vite')
makes the configuration more explicit and self-documenting.
32-32
: LGTM: Correct filename for Vue CLI projects
The change from webpack.config.js
to vue.config.js
is correct as it's the standard configuration filename for Vue CLI projects.
37-37
: LGTM: Consistent plugin initialization
The change to autoImportPlugin('webpack')
maintains consistency with the Vite configuration style and makes the build tool specification explicit.
examples/sites/demos/pc/webdoc/import-components.md (1)
Line range hint 67-82
: LGTM! Configuration is correct and consistent.
The Webpack configuration with TinyVueResolver is properly structured and maintains consistency with the Vite configuration example above.
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
@opentiny/unplugin-tiny-vue
with Vite and Webpack.pnpm
.