Skip to content

docs: update config file examples with title#6368

Merged
chenjiahan merged 1 commit intomainfrom
config_title_1015
Oct 15, 2025
Merged

docs: update config file examples with title#6368
chenjiahan merged 1 commit intomainfrom
config_title_1015

Conversation

@chenjiahan
Copy link
Member

Summary

Update code examples in config documentation files with explicit file titles (e.g., ts title="rsbuild.config.ts") for better clarity and consistency.

Checklist

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

Copilot AI review requested due to automatic review settings October 15, 2025 09:14
@netlify
Copy link

netlify bot commented Oct 15, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 1049dfc
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68ef65db9b06df00087ba128
😎 Deploy Preview https://deploy-preview-6368--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 61 (🔴 down 4 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
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 updates code examples in Chinese and English config documentation files by adding explicit file titles (e.g., ts title="rsbuild.config.ts") to TypeScript code blocks for better clarity and consistency.

  • Updates code block declarations from js or ts to ts title="rsbuild.config.ts"
  • Standardizes configuration examples across all documentation files
  • Improves code clarity by explicitly showing the target filename

Reviewed Changes

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

Show a summary per file
File Description
website/docs/zh/config/tools/swc.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/style-loader.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/postcss.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/lightningcss-loader.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/html-plugin.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/css-loader.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/tools/css-extract.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/source/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/server/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/security/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/resolve/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/performance/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/output/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/html/*.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/environments.mdx Added title attributes to TypeScript config examples
website/docs/zh/config/dev/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/tools/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/source/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/server/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/security/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/resolve/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/performance/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/output/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/html/*.mdx Added title attributes to TypeScript config examples
website/docs/en/config/environments.mdx Added title attributes to TypeScript config examples
website/docs/en/config/dev/*.mdx Added title attributes to TypeScript config examples

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@chenjiahan chenjiahan merged commit bd7c2dc into main Oct 15, 2025
12 checks passed
@chenjiahan chenjiahan deleted the config_title_1015 branch October 15, 2025 09:16
@chenjiahan chenjiahan mentioned this pull request Oct 30, 2025
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.

1 participant