Skip to content

docs(theme): refactor home page and component documentation#3015

Merged
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/ce0e-homehero-homefea
Jan 19, 2026
Merged

docs(theme): refactor home page and component documentation#3015
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/ce0e-homehero-homefea

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Jan 16, 2026 •
edited
Loading

Summary

Refactored the documentation for the Home page and its components (HomeHero, HomeFeature) to improve clarity and reduce duplication.

  • Home Page: Added a new "Home Components" section listing available components (HomeHero, HomeFeature, HomeFooter, HomeBackground) and explaining they can be customized via eject. Added a warning note about overriding HomeLayout.
  • HomeHero / HomeFeature: Removed detailed frontmatter configuration tables from component docs and instead linked to the central Frontmatter Config page to avoid maintenance issues. Clarified that HomeHero reads configuration via useFrontmatter.

Related Issue

N/A

Checklist

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

AI Summary

Refactored HomeHero, HomeFeature, and Home Page documentation to centralize configuration details and clarify customization options.

  • Removed redundant frontmatter config details from HomeHero and HomeFeature docs, linking to the main config page instead.
  • Updated Home Page docs to list available components and provide guidance on customization (eject vs. layout override).
  • Clarified HomeHero uses useFrontmatter for configuration.

This PR was written using Vibe Kanban

@SoonIter
我已完成 HomeHero 和 HomeFeature 组件文档的修改，删除了 frontmatter 相关的详细配置内容，并添加…
8ba8dc9 
…了指向 `frontmatter` 配置页面的链接。

**修改的文件：**

1.  `website/docs/zh/ui/components/home-hero.mdx` (中文)
    *   删除了 YAML 配置示例。
    *   删除了 "Hero 配置" 章节。
    *   在 "用法" 中添加了指向 `/api/config/config-frontmatter#hero` 的链接。

2.  `website/docs/en/ui/components/home-hero.mdx` (英文)
    *   删除了 YAML 配置示例。
    *   删除了 "Hero configuration" 章节。
    *   在 "Usage" 中添加了指向 `/api/config/config-frontmatter#hero` 的链接。

3.  `website/docs/zh/ui/components/home-feature.mdx` (中文)
    *   修改了 "用法" 部分的描述，添加了指向 `/api/config/config-frontmatter#features` 的链接。

4.  `website/docs/en/ui/components/home-feature.mdx` (英文)
    *   删除了 YAML 配置示例。
    *   修改了 "Usage" 部分的描述，添加了指向 `/api/config/config-frontmatter#features` 的链接。

所有文件已根据项目规范进行了格式化。
@SoonIter
已完成文档修改。
c0e4dc8 
**修改文件:**
*   `website/docs/zh/guide/basic/home-page.mdx` (中文)
*   `website/docs/en/guide/basic/home-page.mdx` (英文)

**修改内容:**
在首页文档末尾增加了 "Home 组件" (Home Components) 章节，列出了以下组件的链接：
*   HomeHero
*   HomeFeature
*   HomeFooter
*   HomeBackground

并在最后再次强调并提供了指向 "Frontmatter 配置" (Frontmatter Config) 的链接。
@SoonIter
我已完成所有修改：
1b55731 
1.  **Home Page 文档 (`home-page.mdx`):**
    *   修改了 "Home 组件" 章节的描述为："Rspress 首页由这些组件组成，你可以通过 eject 定制" (及对应的英文 "The Rspress Home page consists of these components, which you can customize via eject")。
    *   增加了一个 Warning 提示框，说明可以通过覆盖 `HomeLayout` 来定制整个首页，但需要自行处理 frontmatter 的读取。

2.  **Home Hero 文档 (`home-hero.mdx`):**
    *   修改了组件读取配置的描述，明确指出是通过 `useFrontmatter` 读取的。
    *   添加了指向 `useFrontmatter` 文档的链接。

所有文件（包括中文和英文版本）都已更新并格式化。
Copilot AI review requested due to automatic review settings January 16, 2026 09:29
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 16, 2026 •
edited
Loading

✅ Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit 1b55731
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/696a050b695e890008e9d202
😎 Deploy Preview https://deploy-preview-3015--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 HomeHero 和 HomeFeature 的文档修改一下，frontmatter 相关配置的内容删除，改为链接到 frontmatter 页面，比如 /api/config/config-frontmatter#hero (vibe-kanban) docs(theme): refactor home page and component documentation Jan 16, 2026
Copilot AI reviewed Jan 16, 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 refactors documentation for the HomeHero and HomeFeature components by removing duplicated frontmatter configuration details and replacing them with links to the centralized Frontmatter configuration page. This improves maintainability by having a single source of truth for configuration documentation.

Changes:

  • Removed detailed frontmatter configuration examples and type definitions from HomeHero and HomeFeature component documentation
  • Added concise descriptions with links to the centralized Frontmatter Config page for hero and features configurations
  • Added new "Home components" section to the home-page guide documenting available components and their customization options

Reviewed changes

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

Show a summary per file
File Description
website/docs/zh/ui/components/home-hero.mdx Replaced detailed hero configuration documentation with a brief description and link to centralized config
website/docs/zh/ui/components/home-feature.mdx Updated to link to centralized features configuration documentation
website/docs/zh/guide/basic/home-page.mdx Added Home components section and configuration reference
website/docs/en/ui/components/home-hero.mdx English version of home-hero documentation updates
website/docs/en/ui/components/home-feature.mdx English version of home-feature documentation updates
website/docs/en/guide/basic/home-page.mdx English version of home-page documentation additions

💡 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 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 -24.8 KB (-0.2%)
node_md 1.3 MB -3.6 KB (-0.3%)
web 15.9 MB -31.5 KB (-0.2%)
📋 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 -24.8 KB (-0.2%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 10.4 MB 10.4 MB -24.8 KB (-0.2%)
📁 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 -3.6 KB (-0.3%)
📄 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 -3.6 KB (-0.3%)

📦 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 -31.5 KB (-0.2%)
📄 JavaScript 15.1 MB 15.1 MB -29.4 KB (-0.2%)
🎨 CSS 125.7 KB 125.7 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 720.4 KB 722.6 KB -2.2 KB (-0.3%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter requested a review from Timeless0911 January 19, 2026 03:15
@SoonIter SoonIter merged commit 7de89c8 into main Jan 19, 2026
16 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/ce0e-homehero-homefea branch January 19, 2026 04:15
This was referenced Jan 19, 2026
Merged
Merged
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