Skip to content

docs: adjust structure#2884

Merged
SoonIter merged 2 commits intomainfrom
syt/doc-polish
Dec 12, 2025
Merged

docs: adjust structure#2884
SoonIter merged 2 commits intomainfrom
syt/doc-polish

Conversation

@SoonIter
Copy link
Copy Markdown
Member

Summary

docs: adjust structure

Related Issue

Checklist

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

Copilot AI review requested due to automatic review settings December 12, 2025 09:05
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 12, 2025

Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit ab80745
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/693bdf71ce4b6c0008065896
😎 Deploy Preview https://deploy-preview-2884--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.

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 reorganizes the documentation structure by moving and consolidating content from the guide/default-theme directory into other more appropriate locations.

Key Changes:

  • Consolidated theme-related documentation by moving custom-page.mdx from guide/basic/ to ui/ directory
  • Moved internationalization and multi-version documentation from guide/default-theme/ to guide/basic/
  • Moved overview page documentation from guide/default-theme/ to guide/advanced/
  • Updated _meta.json files to reflect the new structure, including changing some entries from "type": "dir" to "type": "dir-section-header" for plugin directories
  • Updated internal links to reflect the new file locations
  • Added title field to home page frontmatter for both English and Chinese versions

Reviewed changes

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

Show a summary per file
File Description
website/docs/zh/ui/custom-page.mdx New file with comprehensive documentation on customizing pages (global components, styles, layout structure, and tags)
website/docs/zh/ui/_meta.json Added custom-page entry to include new documentation in navigation
website/docs/zh/plugin/_meta.json Changed plugin directory types from dir to dir-section-header for better categorization
website/docs/zh/index.md Added title field to home page frontmatter
website/docs/zh/guide/start/introduction.mdx Updated links to reflect new locations of custom-page and i18n documentation
website/docs/zh/guide/default-theme/navbar.mdx File deleted as part of restructuring
website/docs/zh/guide/default-theme/doc-page.mdx File deleted as part of restructuring
website/docs/zh/guide/default-theme/components.mdx File deleted as part of restructuring
website/docs/zh/guide/default-theme/_meta.json File deleted as part of restructuring
website/docs/zh/guide/basic/multi-version.mdx New file documenting multi-version document management
website/docs/zh/guide/basic/i18n.mdx New file documenting internationalization setup
website/docs/zh/guide/basic/home-page.mdx New file documenting home page configuration with updated frontmatter example
website/docs/zh/guide/basic/_meta.json Removed custom-page entry and added i18n, multi-version, and home-page entries
website/docs/zh/guide/advanced/overview-page.mdx New file documenting overview/preview page functionality
website/docs/zh/guide/advanced/_meta.json Added overview-page entry at the beginning
website/docs/zh/guide/_meta.json Removed default-theme directory section header
website/docs/en/ui/custom-page.mdx English version of custom page documentation
website/docs/en/ui/_meta.json Added custom-page entry
website/docs/en/plugin/_meta.json Changed plugin directory types to dir-section-header
website/docs/en/index.md Added title field to home page frontmatter
website/docs/en/guide/start/introduction.mdx Updated links to new documentation locations
website/docs/en/guide/default-theme/navbar.mdx File deleted as part of restructuring
website/docs/en/guide/default-theme/doc-page.mdx File deleted as part of restructuring
website/docs/en/guide/default-theme/components.mdx File deleted as part of restructuring
website/docs/en/guide/default-theme/_meta.json File deleted as part of restructuring
website/docs/en/guide/basic/multi-version.mdx English version of multi-version documentation
website/docs/en/guide/basic/i18n.mdx English version of internationalization documentation
website/docs/en/guide/basic/home-page.mdx English version of home page documentation with updated frontmatter example
website/docs/en/guide/basic/_meta.json Updated to remove custom-page and add new entries
website/docs/en/guide/advanced/overview-page.mdx English version of overview page documentation
website/docs/en/guide/advanced/_meta.json Added overview-page entry
website/docs/en/guide/_meta.json Removed default-theme directory section header

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

@github-actions
Copy link
Copy Markdown
Contributor

Rsdoctor Bundle Diff Analysis

📁 web

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

📌 Baseline Commit: b76eeb0bb9 | PR: #2879

Metric Current Baseline Change
📊 Total Size 14.6 MB 14.7 MB -94.8 KB (-0.6%)
📄 JavaScript 14.0 MB 14.1 MB -69.2 KB (-0.5%)
🎨 CSS 114.0 KB 114.0 KB 0 B (0.0%)
🌐 HTML 0 B 0 B N/A
📁 Other Assets 489.3 KB 514.9 KB -25.7 KB (-5.0%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter enabled auto-merge (squash) December 12, 2025 09:42
@SoonIter SoonIter disabled auto-merge December 12, 2025 09:43
@SoonIter SoonIter enabled auto-merge (squash) December 12, 2025 09:43
@SoonIter SoonIter merged commit 8e45698 into main Dec 12, 2025
9 checks passed
@SoonIter SoonIter deleted the syt/doc-polish branch December 12, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants