Skip to content

docs: improve plugin-llms warning about implementation limitations and SSR compatibility#2975

Merged
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/ef18-plugin-llms
Jan 7, 2026
Merged

docs: improve plugin-llms warning about implementation limitations and SSR compatibility#2975
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/ef18-plugin-llms

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Jan 7, 2026

Summary

Related Issue

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

AI Summary

Changes Made

Updated the warning messages in both @rspress/plugin-llms and ssg-md documentation (EN & ZH) to provide clearer guidance:

plugin-llms documentation:

  • Added explanation of implementation principle: uses remark to process MDX source files
  • Clarified limitation: does not support React Hooks, custom components, or other dynamic content rendering
  • Updated fallback scenario description from ssg: false to "when SSG and SSG-MD features cannot be enabled due to code incompatibility with SSR"

ssg-md documentation:

  • Updated the @rspress/plugin-llms reference to use the same clearer description about SSR compatibility

Why These Changes

The previous documentation simply mentioned ssg: false without explaining why users might need to use this setting. The updated documentation:

  1. Helps users understand the technical difference between SSG-MD (React rendering) and plugin-llms (remark processing)
  2. Clarifies that plugin-llms is a fallback for SSR compatibility issues, not just a preference
  3. Sets proper expectations about plugin-llms limitations (no dynamic content support)

This PR was written using Vibe Kanban


1. **实现原理**:使用 remark 处理 MDX 源文件
2. **局限性**:不支持 React Hooks、自定义组件等动态内容的渲染
3. **定位**:仅作为 `ssg: false` 场景下的备选方案,建议优先使用 SSG-MD
Copilot AI review requested due to automatic review settings January 7, 2026 11:50
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 7, 2026

Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit bddb382
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/695e487bd5014b00084defaa
😎 Deploy Preview https://deploy-preview-2975--rspress-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the documentation for the @rspress/plugin-llms plugin by adding explanatory notes about its implementation principles and appropriate usage scenarios. The updates clarify that the plugin uses remark to process MDX files (which limits support for React Hooks and custom components) and should only be used as a fallback when SSG/SSG-MD cannot be enabled due to SSR incompatibility.

  • Added technical implementation details explaining the remark-based processing limitation
  • Updated warning messages to be more specific about when plugin-llms should be used
  • Improved consistency between Chinese and English documentation

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
website/docs/zh/plugin/official-plugins/llms.mdx Added implementation details and clarified usage scenario in Chinese
website/docs/zh/guide/basic/ssg-md.mdx Updated reference to plugin-llms with more specific SSR incompatibility context in Chinese
website/docs/en/plugin/official-plugins/llms.mdx Added implementation details and clarified usage scenario in English
website/docs/en/guide/basic/ssg-md.mdx Updated reference to plugin-llms with more specific SSR incompatibility context in English

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread website/docs/zh/plugin/official-plugins/llms.mdx
Comment thread website/docs/en/plugin/official-plugins/llms.mdx
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 7, 2026

Rsdoctor Bundle Diff Analysis

⚠️ Note: The latest commit (7dcc66abb9) does not have baseline artifacts. Using commit 57100d81c7 for baseline comparison instead. If this seems incorrect, please wait a few minutes and try rerunning the workflow.

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 9.5 MB +343.0 B (0.0%)
node_md 1.2 MB +768.0 B (0.1%)
web 15.3 MB +708.0 B (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

Path: website/doc_build/diff-rsdoctor/node/rsdoctor-data.json

📌 Baseline Commit: 57100d81c7 | PR: #2972

Metric Current Baseline Change
📊 Total Size 9.5 MB 9.5 MB +343.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 9.5 MB 9.5 MB +343.0 B (0.0%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: node Bundle Diff

📁 node_md

Path: website/doc_build/diff-rsdoctor/node_md/rsdoctor-data.json

📌 Baseline Commit: 57100d81c7 | PR: #2972

Metric Current Baseline Change
📊 Total Size 1.2 MB 1.2 MB +768.0 B (0.1%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.2 MB 1.2 MB +768.0 B (0.1%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

Path: website/doc_build/diff-rsdoctor/web/rsdoctor-data.json

📌 Baseline Commit: 57100d81c7 | PR: #2972

Metric Current Baseline Change
📊 Total Size 15.3 MB 15.3 MB +708.0 B (0.0%)
📄 JavaScript 14.6 MB 14.6 MB +311.0 B (0.0%)
🎨 CSS 128.7 KB 128.7 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 556.1 KB 555.7 KB +397.0 B (0.1%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter changed the title 对 plugin-llms 进行一些文档说明 (vibe-kanban) docs: improve plugin-llms warning about implementation limitations and SSR compatibility Jan 7, 2026
@SoonIter SoonIter requested a review from Timeless0911 January 7, 2026 11:58
@SoonIter SoonIter enabled auto-merge (squash) January 7, 2026 11:58
@SoonIter SoonIter merged commit 8ee0cff into main Jan 7, 2026
16 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/ef18-plugin-llms branch January 7, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants