Skip to content

docs(SSR): add SSR compatibility documentation and integrate warnings into component READMEs and FAQ.#13760

Open
gaoxiao6331 wants to merge 3 commits intoyouzan:mainfrom
gaoxiao6331:docs/ssr
Open

docs(SSR): add SSR compatibility documentation and integrate warnings into component READMEs and FAQ.#13760
gaoxiao6331 wants to merge 3 commits intoyouzan:mainfrom
gaoxiao6331:docs/ssr

Conversation

@gaoxiao6331
Copy link

… into component READMEs and FAQ.

Before submitting a pull request, please read the contributing guide.

在提交 pull request 之前,请阅读 贡献指南

@gemini-code-assist
Copy link

Summary of Changes

Hello @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 SSR Compatibility Documentation: A new documentation page (ssr-issue.en-US.md and ssr-issue.zh-CN.md) has been added to detail Server-Side Rendering (SSR) compatibility issues, specifically mentioning the Tab component as an example.
  • FAQ Updates: The English and Chinese FAQ documents (faq.en-US.md and faq.zh-CN.md) have been updated with a new entry linking to the newly created SSR compatibility documentation.
  • Component README Warnings: The Tab component's READMEs (tab/README.md and tab/README.zh-CN.md) now include a prominent warning about its compatibility issues in SSR scenarios, directing users to the detailed SSR documentation.
  • Navigation Integration: The vant.config.mjs file has been modified to include the new SSR compatibility documentation in the project's navigation structure for both English and Chinese versions.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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).

Suggested change
See [SSR Compatibility Issues](#/en-US/ssr-issue).
See [SSR Compatibility Issues](#/en-US/ssr-issue#intro).
@codecov-commenter
Copy link

codecov-commenter commented Jan 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.93%. Comparing base (ec5b45b) to head (7d56dc6).
⚠️ Report is 210 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

2 participants