docs(SSR): add SSR compatibility documentation and integrate warnings into component READMEs and FAQ.#13760
docs(SSR): add SSR compatibility documentation and integrate warnings into component READMEs and FAQ.#13760gaoxiao6331 wants to merge 3 commits intoyouzan:mainfrom
Conversation
… into component READMEs and FAQ.
Summary of ChangesHello @gaoxiao6331, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation around Server-Side Rendering (SSR) compatibility within the Vant UI library. The primary goal is to proactively inform developers about components that may exhibit issues in SSR environments due to their reliance on browser-specific APIs. By adding a dedicated guide, updating the FAQ, and integrating warnings directly into component documentation, this change improves clarity and helps users avoid common pitfalls when implementing Vant components in SSR applications. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces documentation regarding Server-Side Rendering (SSR) compatibility. It adds a new documentation page detailing components with SSR issues, updates the FAQ to link to this new page, and integrates warnings directly into the README files of affected components, starting with the Tab component. The changes are well-implemented across both English and Chinese documentation. I have one minor suggestion to improve link consistency.
|
|
||
| ### Why are some components not compatible with Server-Side Rendering (SSR)? | ||
|
|
||
| See [SSR Compatibility Issues](#/en-US/ssr-issue). |
There was a problem hiding this comment.
For consistency with the Chinese version of this file (faq.zh-CN.md), which links to a specific section, it would be better to add an anchor to this link to point to the "Intro" section of the SSR issues page. The Chinese version links to #jie-shao which corresponds to ### 介绍 (Intro).
| See [SSR Compatibility Issues](#/en-US/ssr-issue). | |
| See [SSR Compatibility Issues](#/en-US/ssr-issue#intro). |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #13760 +/- ##
==========================================
+ Coverage 89.60% 89.93% +0.32%
==========================================
Files 257 257
Lines 7013 7063 +50
Branches 1736 1755 +19
==========================================
+ Hits 6284 6352 +68
+ Misses 384 373 -11
+ Partials 345 338 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
… into component READMEs and FAQ.
Before submitting a pull request, please read the contributing guide.
在提交 pull request 之前,请阅读 贡献指南。