Skip to content

docs(description): add description frontmatter to ui documentation files#3008

Merged
SoonIter merged 2 commits intomainfrom
syt_vk/e078-frontmatter-desc
Jan 19, 2026
Merged

docs(description): add description frontmatter to ui documentation files#3008
SoonIter merged 2 commits intomainfrom
syt_vk/e078-frontmatter-desc

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Jan 14, 2026 •
edited
Loading

Summary

Related Issue

Checklist

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

AI Summary

This PR adds description frontmatter field to all 38 documentation files in the website/docs/zh/ui directory.

Changes Made

Added SEO-friendly description metadata to:

  • Components (21 files): Badge, Banner, Callout, CodeBlockRuntime, DocFooter, EditLink, HomeBackground, HomeFeature, HomeFooter, HomeHero, LastUpdated, OverviewGroup, PackageManagerTabs, PageTabs, PrevNextPage, Root, SourceCode, Steps, Tabs, Tag, and the components index
  • Hooks (12 files): useDark, useFrontmatter, useI18n, useLang, usePage, usePageData, usePages, useSite, useVersion, router-hooks, and the hooks index
  • Other (5 files): custom-page, icons, runtime-components (Head, NoSSR, index), and CSS variables

Why

The description field in frontmatter is used for:

  • SEO meta description tags
  • Search result snippets
  • Social media sharing previews

Each description concisely summarizes the component/hook's purpose in Chinese, following the documentation's language convention.

Example

 ---
+description: Badge 徽章组件，用于在文档中显示小型内联标记，支持多种类型和样式。
 overviewHeaders: []
 ---

This PR was written using Vibe Kanban

@SoonIter
已完成 docs/zh/ui 目录下所有 38 个文档文件的 description 添加。总结如下：
7b5d874 
**components 目录 (21 个文件):**
- badge.mdx - Badge 徽章组件
- banner.mdx - Banner 通知横幅组件
- callout.mdx - Callout 提示框组件
- code-block-runtime.mdx - CodeBlockRuntime 运行时代码块组件
- doc-footer.mdx - DocFooter 文档页脚组件
- edit-link.mdx - EditLink 编辑链接组件
- home-background.mdx - HomeBackground 首页背景组件
- home-feature.mdx - HomeFeature 首页特性组件
- home-footer.mdx - HomeFooter 首页页脚组件
- home-hero.mdx - HomeHero 首页主视觉组件
- index.mdx - 内置组件概览
- last-updated.mdx - LastUpdated 最后更新时间组件
- overview-group.mdx - OverviewGroup 概览分组组件
- package-manager-tabs.mdx - PackageManagerTabs 包管理器标签组件
- page-tabs.mdx - PageTabs 页面标签组件
- prev-next-page.mdx - PrevNextPage 上下页导航组件
- root.mdx - Root 根组件
- source-code.mdx - SourceCode 源码链接组件
- steps.mdx - Steps 步骤组件
- tabs.mdx - Tabs 标签页组件
- tag.mdx - Tag 标签组件

**hooks 目录 (12 个文件):**
- index.mdx - 内置 hooks 概览
- router-hooks.mdx - 路由相关 hooks
- use-dark.mdx - useDark hook
- use-frontmatter.mdx - useFrontmatter hook
- use-i18n.mdx - useI18n hook
- use-lang.mdx - useLang hook
- use-page-data.mdx - usePageData hook（已废弃）
- use-page.mdx - usePage hook
- use-pages.mdx - usePages hook
- use-site.mdx - useSite hook
- use-version.mdx - useVersion hook

**其他文件 (5 个):**
- custom-page.mdx - 自定义页面
- icons/index.mdx - 内置图标
- runtime-components/index.mdx - 运行时组件概览
- runtime-components/head.mdx - Head 组件
- runtime-components/no-ssr.mdx - NoSSR 组件
- vars.mdx - CSS 变量
Copilot AI review requested due to automatic review settings January 14, 2026 14:49
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 14, 2026 •
edited
Loading

✅ Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit ef26648
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/6968b60a0b4b1800097ae3dd
😎 Deploy Preview https://deploy-preview-3008--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 给文档的 frontmatter 增加 description (vibe-kanban) docs(zh): add description frontmatter to docs/zh/ui documentation files Jan 14, 2026
Copilot AI reviewed Jan 14, 2026
View reviewed changes
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 pull request adds description metadata to the frontmatter of 40 Chinese documentation files in the Rspress UI section. These descriptions improve SEO and provide quick summaries of each page's content for documentation readers.

Changes:

  • Added description fields to frontmatter for all documentation files under website/docs/zh/ui/
  • Descriptions cover hooks, components, runtime components, CSS variables, icons, and custom page documentation

Reviewed changes

Copilot reviewed 38 out of 38 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/docs/zh/ui/vars.mdx Added description for CSS variables documentation
website/docs/zh/ui/runtime-components/no-ssr.mdx Added description for NoSSR runtime component
website/docs/zh/ui/runtime-components/index.mdx Added description for runtime components overview
website/docs/zh/ui/runtime-components/head.mdx Added description for Head runtime component
website/docs/zh/ui/icons/index.mdx Added description for built-in icons documentation
website/docs/zh/ui/hooks/use-version.mdx Added description for useVersion hook
website/docs/zh/ui/hooks/use-site.mdx Added description for useSite hook
website/docs/zh/ui/hooks/use-pages.mdx Added description for usePages hook
website/docs/zh/ui/hooks/use-page.mdx Added description for usePage hook
website/docs/zh/ui/hooks/use-page-data.mdx Added description for deprecated usePageData hook
website/docs/zh/ui/hooks/use-lang.mdx Added description for useLang hook
website/docs/zh/ui/hooks/use-i18n.mdx Added description for useI18n hook
website/docs/zh/ui/hooks/use-frontmatter.mdx Added description for useFrontmatter hook
website/docs/zh/ui/hooks/use-dark.mdx Added description for useDark hook
website/docs/zh/ui/hooks/router-hooks.mdx Added description for router hooks
website/docs/zh/ui/hooks/index.mdx Added description for hooks overview
website/docs/zh/ui/custom-page.mdx Added description for custom page documentation
website/docs/zh/ui/components/tag.mdx Added description for Tag component
website/docs/zh/ui/components/tabs.mdx Added description for Tabs component
website/docs/zh/ui/components/steps.mdx Added description for Steps component
website/docs/zh/ui/components/source-code.mdx Added description for SourceCode component
website/docs/zh/ui/components/root.mdx Added description for Root component
website/docs/zh/ui/components/prev-next-page.mdx Added description for PrevNextPage component
website/docs/zh/ui/components/page-tabs.mdx Added description for PageTabs component
website/docs/zh/ui/components/package-manager-tabs.mdx Added description for PackageManagerTabs component
website/docs/zh/ui/components/overview-group.mdx Added description for OverviewGroup component
website/docs/zh/ui/components/last-updated.mdx Added description for LastUpdated component
website/docs/zh/ui/components/index.mdx Added description for components overview
website/docs/zh/ui/components/home-hero.mdx Added description for HomeHero component
website/docs/zh/ui/components/home-footer.mdx Added description for HomeFooter component
website/docs/zh/ui/components/home-feature.mdx Added description for HomeFeature component
website/docs/zh/ui/components/home-background.mdx Added description for HomeBackground component
website/docs/zh/ui/components/edit-link.mdx Added description for EditLink component
website/docs/zh/ui/components/doc-footer.mdx Added description for DocFooter component
website/docs/zh/ui/components/code-block-runtime.mdx Added description for CodeBlockRuntime component
website/docs/zh/ui/components/callout.mdx Added description for Callout component
website/docs/zh/ui/components/banner.mdx Added description for Banner component
website/docs/zh/ui/components/badge.mdx Added description for Badge component

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 14, 2026 •
edited
Loading

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 10.4 MB -6.8 KB (-0.1%)
node_md 1.3 MB -6.5 KB (-0.5%)
web 15.9 MB +10.3 KB (0.1%)
📋 Detailed Reports (Click to expand)

📁 node

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

📌 Baseline Commit: 2546e80d32 | PR: #3009

Metric Current Baseline Change
📊 Total Size 10.4 MB 10.5 MB -6.8 KB (-0.1%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 10.4 MB 10.5 MB -6.8 KB (-0.1%)
📁 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: 2546e80d32 | PR: #3009

Metric Current Baseline Change
📊 Total Size 1.3 MB 1.3 MB -6.5 KB (-0.5%)
📄 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 -6.5 KB (-0.5%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

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

📌 Baseline Commit: 2546e80d32 | PR: #3009

Metric Current Baseline Change
📊 Total Size 15.9 MB 15.9 MB +10.3 KB (0.1%)
📄 JavaScript 15.1 MB 15.1 MB +8.9 KB (0.1%)
🎨 CSS 126.3 KB 126.3 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 716.5 KB 715.1 KB +1.4 KB (0.2%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter changed the title docs(zh): add description frontmatter to docs/zh/ui documentation files docs(description): add description frontmatter to docs/zh/ui documentation files Jan 15, 2026
@SoonIter SoonIter requested a review from Timeless0911 January 15, 2026 12:46
@SoonIter SoonIter changed the title docs(description): add description frontmatter to docs/zh/ui documentation files docs(description): add description frontmatter to ui documentation files Jan 16, 2026
@SoonIter SoonIter enabled auto-merge (squash) January 16, 2026 08:44
@SoonIter SoonIter merged commit 38a630e into main Jan 19, 2026
10 checks passed
@SoonIter SoonIter deleted the syt_vk/e078-frontmatter-desc branch January 19, 2026 05:24
@github-actions github-actions bot mentioned this pull request Jan 19, 2026
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Timeless0911 Timeless0911 Timeless0911 approved these changes

Assignees

No one assigned

Labels

change: docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SoonIter @Timeless0911