docs: refactor section headers #1342
Merged
+161
−173
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for rslib ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Copilot finished reviewing on behalf of
Timeless0911
November 17, 2025 12:01
Contributor
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
refactor section headers
Related Links
Checklist