Skip to content

Conversation

@chenjiahan
Copy link
Member

@chenjiahan chenjiahan commented May 18, 2023

Summary

🤖 Generated by Copilot at 011e939

This pull request improves the formatting, consistency, grammar, and clarity of the English and Chinese documentation of various configuration options in the builder-doc package of the modern.js repository. It also fixes some minor errors and adds some examples and subheadings. The affected files are mostly in the ./packages/document/builder-doc/docs/en/config and ./packages/document/builder-doc/docs/zh/config directories.

Details

🤖 Generated by Copilot at 011e939

  • Add colons after the words "Type" and "Default" in the English documentation of the output.dataUriLimit, output.distPath, and output.filename configuration options (link, link, link, link, link, link)
  • Add single quotes around the values url and component in the English and Chinese documentation of the output.svgDefaultExport configuration option (link, link)
  • Replace the word "by" with "with" and the word "packaging" with "bundler" and the word "configuring" with "using" in the English documentation of the tools.babel configuration option (link)
  • Remove the extra spaces between the type union in the English and Chinese documentation of the tools.rspack, tools.styledComponents, and tools.webpack configuration options (link, link, link, link, link, link)
  • Replace the word "configure" with "configured" and add sentences to explain the object and function types and examples of adding or modifying configuration in the English and Chinese documentation of the tools.rspack and tools.webpack configuration options (link, link, link, link, link, link, link, link)
  • Add tips to explain that the object returned by the tools.rspack and tools.webpack functions is used directly as the final configuration and not merged with the built-in configuration and rephrase the sentences to explain the second parameter of the function types in the English and Chinese documentation of the tools.rspack and tools.webpack configuration options (link, link, link, link)
  • Add subheadings for the utility functions and properties in the English and Chinese documentation of the tools.rspack and tools.webpack configuration options (link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link)
  • Replace the word "值为" with "它的值为" in the Chinese documentation of the tools.bundlerChain and tools.webpackChain configuration options (link, link)

Related Issue

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@changeset-bot
Copy link

changeset-bot bot commented May 18, 2023

⚠️ No Changeset found

Latest commit: 011e939

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chenjiahan chenjiahan merged commit 1714ada into web-infra-dev:main May 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants