Skip to content

docs(zh): rename "预览页" to "Overview 页" for terminology consistency#3016

Merged
SoonIter merged 2 commits intomainfrom
syt-vibe-kanban/a844-zh-overview
Jan 19, 2026
Merged

docs(zh): rename "预览页" to "Overview 页" for terminology consistency#3016
SoonIter merged 2 commits intomainfrom
syt-vibe-kanban/a844-zh-overview

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Jan 16, 2026

Summary

Standardize Chinese documentation terminology by replacing "预览页" (preview page) with "Overview 页" to align with the English documentation and the actual feature name.

Related Issue

Checklist

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

AI Summary

What was changed

This PR updates the Chinese documentation to use consistent terminology for the "Overview page" feature. All instances of "预览页" (which literally translates to "preview page") have been replaced with "Overview 页" across 5 documentation files:

File Changes
guide/advanced/overview-page.mdx 9 replacements (title, description, and body text)
api/config/config-frontmatter.mdx 4 replacements (section titles and related descriptions)
guide/basic/auto-nav-sidebar.mdx 2 replacements (overviewHeaders field descriptions)
ui/components/overview-group.mdx 1 replacement (component description)
ui/hooks/use-pages.mdx 1 replacement (hook description)

Why this change was made

  • Terminology consistency: The feature is called "Overview page" in English, and the component/hook names use "overview" (e.g., OverviewGroup, overviewHeaders). Using "Overview 页" in Chinese documentation maintains consistency with the codebase and English docs.
  • Reduced confusion: "预览页" (preview page) could be misunderstood as a page preview feature, whereas "Overview 页" clearly indicates it's an overview/summary page.
  • Better alignment: This change aligns the Chinese documentation with the actual feature naming convention used throughout Rspress.

Implementation details

This is a pure documentation change with no code modifications. A total of 17 text replacements were made across the 5 files, covering page titles, section headers, descriptions, and inline references.

This PR was written using Vibe Kanban


1. **`guide/advanced/overview-page.mdx`** - 9 处修改(标题、描述及正文)
2. **`api/config/config-frontmatter.mdx`** - 4 处修改(章节标题及相关说明)
3. **`guide/basic/auto-nav-sidebar.mdx`** - 2 处修改(`overviewHeaders` 字段说明)
4. **`ui/components/overview-group.mdx`** - 1 处修改(组件描述)
5. **`ui/hooks/use-pages.mdx`** - 1 处修改(hook 描述)
Copilot AI review requested due to automatic review settings January 16, 2026 09:49
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 16, 2026

Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit 2937924
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/696a0ae3c81c920008b9af84
😎 Deploy Preview https://deploy-preview-3016--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.

@SoonIter SoonIter changed the title zh 文档中, 预览页改为 Overview 页 (vibe-kanban) docs(zh): rename "预览页" to "Overview 页" for terminology consistency Jan 16, 2026
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 standardizes terminology in the Chinese (zh) documentation by replacing "预览页" (preview page) with "Overview 页" (Overview page) to maintain consistency with the feature name across all documentation files.

Changes:

  • Updated all references from "预览页" to "Overview 页" in Chinese documentation
  • Affected files include hook documentation, component documentation, configuration guides, and the main feature documentation

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
website/docs/zh/ui/hooks/use-pages.mdx Updated link text from "预览页" to "Overview 页" in the description of usePages hook
website/docs/zh/ui/components/overview-group.mdx Updated reference from "预览页" to "Overview 页" in OverviewGroup component description
website/docs/zh/guide/basic/auto-nav-sidebar.mdx Updated two instances in the auto-nav-sidebar guide where "预览页" was changed to "Overview 页"
website/docs/zh/guide/advanced/overview-page.mdx Updated page title, section headings, and multiple references throughout the overview page documentation from "预览页" to "Overview 页"
website/docs/zh/api/config/config-frontmatter.mdx Updated section heading and multiple references in frontmatter configuration documentation from "预览页" to "Overview 页"

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

Comment thread website/docs/zh/guide/advanced/overview-page.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 16, 2026

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 10.4 MB +170.0 B (0.0%)
node_md 1.3 MB +145.0 B (0.0%)
web 15.9 MB +192.0 B (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

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

📌 Baseline Commit: 1094824e36 | PR: #3014

Metric Current Baseline Change
📊 Total Size 10.4 MB 10.4 MB +170.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 10.4 MB 10.4 MB +170.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: 1094824e36 | PR: #3014

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

📦 Download Diff Report: node_md Bundle Diff

📁 web

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

📌 Baseline Commit: 1094824e36 | PR: #3014

Metric Current Baseline Change
📊 Total Size 15.9 MB 15.9 MB +192.0 B (0.0%)
📄 JavaScript 15.1 MB 15.1 MB +112.0 B (0.0%)
🎨 CSS 125.7 KB 125.7 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 722.7 KB 722.6 KB +80.0 B (0.0%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SoonIter SoonIter requested a review from Timeless0911 January 19, 2026 03:14
@SoonIter SoonIter enabled auto-merge (squash) January 19, 2026 03:32
@SoonIter SoonIter merged commit 416a9c8 into main Jan 19, 2026
8 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/a844-zh-overview branch January 19, 2026 03:57
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