docs: refactor section headers #1342
Conversation
✅ Deploy Preview for rslib ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR refactors documentation section headers to improve navigation and consistency across the documentation site. The changes modernize the structure by introducing new section header types and reorganizing configuration documentation.
Key changes:
- Refactored
Overview.tsxcomponent to use the built-inOverviewGroupcomponent from@rspress/core/themeinstead of custom implementation - Updated section types in
_meta.jsonfiles from"dir"to"dir-section-header"and introduced"section-header"type - Standardized index page titles to "Overview" (or "总览" in Chinese) across configuration and solution sections
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| website/theme/components/Overview.tsx | Refactored to use OverviewGroup component with i18n support and hardcoded configuration items |
| website/theme/components/Overview.module.scss | Removed custom styles as component now uses theme's built-in styling |
| website/docs/en/guide/_meta.json | Changed section types to "dir-section-header" and updated "Getting Started" label to "Start" |
| website/docs/zh/guide/_meta.json | Changed section types to "dir-section-header" for consistency |
| website/docs/en/guide/solution/index.mdx | Changed page title from "Solution" to "Overview" |
| website/docs/zh/guide/solution/index.mdx | Changed page title from "解决方案" to "总览" |
| website/docs/en/guide/solution/_meta.json | Added "index" to navigation order |
| website/docs/zh/guide/solution/_meta.json | Added "index" to navigation order |
| website/docs/en/config/_meta.json | Changed section types and restructured with new "section-header" type |
| website/docs/zh/config/_meta.json | Changed section types and restructured with new "section-header" type |
| website/docs/en/config/index.mdx | Changed frontmatter to use pageType and added Overview component |
| website/docs/zh/config/index.mdx | Changed frontmatter to use pageType and added Overview component |
| website/docs/en/config/lib/index.mdx | Changed title to "Overview" and reordered interface properties |
| website/docs/zh/config/lib/index.mdx | Changed title to "总览" and reordered interface properties |
| website/docs/en/config/lib/_meta.json | Added "index" and reordered configuration items alphabetically |
| website/docs/zh/config/lib/_meta.json | Added "index" and reordered configuration items alphabetically |
| website/docs/en/config/rsbuild/index.mdx | Changed title to "Overview" and moved tip section |
| website/docs/zh/config/rsbuild/index.mdx | Changed title to "总览" and moved tip section |
| website/docs/en/config/rsbuild/_meta.json | Added "index" to navigation order |
| website/docs/zh/config/rsbuild/_meta.json | Added "index" to navigation order |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Overview | ||
|
|
There was a problem hiding this comment.
Duplicate "Overview" header. The page already has # Overview at line 3, so this ## Overview section header should be removed.
| ## Overview |
| format?: Format; | ||
| id?: string; | ||
| outBase?: string; | ||
| footer?: BannerAndFooter; |
There was a problem hiding this comment.
The interface properties are not in alphabetical order. footer should come before format alphabetically (footer < format).
| format?: Format; | |
| id?: string; | |
| outBase?: string; | |
| footer?: BannerAndFooter; | |
| footer?: BannerAndFooter; | |
| format?: Format; | |
| id?: string; | |
| outBase?: string; |
| format?: Format; | ||
| id?: string; | ||
| outBase?: string; | ||
| footer?: BannerAndFooter; |
There was a problem hiding this comment.
The interface properties are not in alphabetical order. footer should come before format alphabetically (footer < format).
| format?: Format; | |
| id?: string; | |
| outBase?: string; | |
| footer?: BannerAndFooter; | |
| footer?: BannerAndFooter; | |
| format?: Format; | |
| id?: string; | |
| outBase?: string; |
| "umd-name", | ||
| "out-base", | ||
| "experiments" | ||
| "footer", |
There was a problem hiding this comment.
The configuration items are not in alphabetical order. "footer" should come before "format" alphabetically (footer < format).
| "umd-name", | ||
| "out-base", | ||
| "experiments" | ||
| "footer", |
There was a problem hiding this comment.
The configuration items are not in alphabetical order. "footer" should come before "format" alphabetically (footer < format).
| { text: 'lib.footer', link: '/config/lib/footer' }, | ||
| { text: 'lib.format', link: '/config/lib/format' }, |
There was a problem hiding this comment.
Inconsistent ordering between Overview.tsx and _meta.json. In Overview.tsx line 21-22, footer appears before format (alphabetically correct), but in _meta.json line 10-13, format appears before footer (alphabetically incorrect). These should be consistent.
Summary
refactor section headers
Related Links
Checklist