Skip to content

docs: improve section headers#12216

Merged
chenjiahan merged 1 commit intomainfrom
section_headers_1117
Nov 17, 2025
Merged

docs: improve section headers#12216
chenjiahan merged 1 commit intomainfrom
section_headers_1117

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

Summary

This PR uses Rspress v2's new section-header type to improve section header for Rspack documentation.

Before:

image

After:

image

Checklist

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

Copilot AI review requested due to automatic review settings November 17, 2025 08:22
@netlify
Copy link
Copy Markdown

netlify bot commented Nov 17, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit f00d794
🔍 Latest deploy log https://app.netlify.com/projects/rspack/deploys/691adb4efd26ae00084d1377
😎 Deploy Preview https://deploy-preview-12216--rspack.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.

@github-actions github-actions bot added team The issue/pr is created by the member of Rspack. release: document release: document related release(mr only) labels Nov 17, 2025
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 modernizes the Rspack documentation structure by adopting Rspress v2's new section-header and dir-section-header types, improving navigation and visual organization of the documentation.

  • Updates all _meta.json configuration files to use new Rspress v2 section header types
  • Improves page titles for better clarity (e.g., "Introduction" → "Rspack plugins", "Overview" → "Contributing guide")
  • Reorganizes plugin documentation sections for better logical grouping

Reviewed Changes

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

Show a summary per file
File Description
website/docs/zh/plugins/index.mdx Updates plugin page title and reorganizes content sections to align with new navigation structure
website/docs/zh/plugins/_meta.json Adds section headers and changes directory types to dir-section-header for improved navigation
website/docs/zh/misc/_meta.json Updates directory types from dir to dir-section-header
website/docs/zh/guide/_meta.json Updates all guide section directory types to dir-section-header
website/docs/zh/contribute/index.mdx Changes page title from "总览" to "贡献指南" for better clarity
website/docs/zh/contribute/_meta.json Adds "开始" section header and updates directory types
website/docs/zh/config/_meta.json Adds "介绍" and "配置项" section headers to organize config documentation
website/docs/zh/api/index.mdx Updates page title from "简介" to "Rspack APIs"
website/docs/zh/api/_meta.json Adds "介绍" section header and updates directory types
website/docs/en/plugins/index.mdx Updates plugin page title and reorganizes content sections (English version)
website/docs/en/plugins/_meta.json Adds section headers and updates directory types (English version)
website/docs/en/misc/_meta.json Updates directory types to dir-section-header (English version)
website/docs/en/guide/_meta.json Updates directory types and shortens "Getting started" to "Start"
website/docs/en/contribute/index.mdx Changes title to "Contributing guide" and adds line break
website/docs/en/contribute/_meta.json Adds "Start" section header and updates directory types (English version)
website/docs/en/config/_meta.json Adds section headers for "Introduction" and "Config options"
website/docs/en/api/_meta.json Adds "Introduction" section header and updates directory types (English version)

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

@chenjiahan chenjiahan enabled auto-merge (squash) November 17, 2025 08:28
@chenjiahan chenjiahan merged commit 1158315 into main Nov 17, 2025
35 checks passed
@chenjiahan chenjiahan deleted the section_headers_1117 branch November 17, 2025 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants