Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(module-tools): update plugins and api doc title #4101

Merged
merged 1 commit into from
Jun 30, 2023

Conversation

chenjiahan
Copy link
Member

@chenjiahan chenjiahan commented Jun 30, 2023

Summary

🤖 Generated by Copilot at bc4fdfe

This pull request reorganizes and updates the documentation for the modern.js framework, especially the builder plugins feature. It moves some files to different directories and languages, fixes typos and code formatting, and improves the type notation and clarity of the configuration options. It also changes the link texts to use quotation marks for consistency.

Details

🤖 Generated by Copilot at bc4fdfe

  • Change the file paths and descriptions of the buildConfig option in the zh and en versions of the build-config.md document to reflect the new location and language of the document and provide more details and clarity (link,link)
  • Change the file paths of the build-preset.mdx, design-system.md, dev.md, plugins.md, and testing.md documents in the zh and en versions to reflect the new location and language of the document (link,link,link,link,link,link,link,link,link,link)
  • Change the import statements in the zh version of the builder-plugins.mdx document to use named imports instead of default imports, as the my-builder-plugin package and the local myBuilderPlugin file export the plugin as a named export (link,link,link)
  • Change the types of various options in the zh and en versions of the build-config.md document from Object and Array to object, object[], string | Function, and string literals to use the lowercase notation for primitive types and the array and union notations for TypeScript (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,link,link,link,link,link)
  • Change the link texts in the zh and en versions of various documents from brackets to quotation marks for consistency (link,link,link,link,link,link)
  • Change the code blocks in the zh and en versions of the dev.md document from ts to js or vice versa to match the file extension (link,link,link,link,link,link)
  • Change the version of the @modern-js/module-tools package in the en version of the plugin-import.mdx document to include the v prefix for consistency and wrap the name of the package in backticks to indicate it is a code literal (link)
  • Change the import statements in the en version of the plugin-import.mdx document to use named imports instead of default imports, as the @modern-js/module-tools package exports the defineConfig function as a named export (link,link,link)
  • Change the type of the pluginImport option in the en version of the plugin-import.mdx document from Array to object[] to use the array notation for TypeScript (link)
  • Change the descriptions of the style.less.implementation and style.sass.implementation options in the zh version of the build-config.md document to use a more consistent wording (link,link)
  • Add commas at the end of the object properties and array elements in the zh and en versions of various documents for consistency (link,link,link,link,link,link,link,link,link,link)
  • Add periods at the end of the sentences in the zh and en versions of various documents for consistency (link,link,link)
  • Add blank lines between the frontmatter and the markdown content, the code blocks and the next paragraphs, and the tip sections and the next paragraphs in the zh and en versions of various documents for better readability (link,link,link)
  • Change the line number for the focus annotation in the en version of the plugin-import.mdx document to match the new code (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 Jun 30, 2023

⚠️ No Changeset found

Latest commit: bc4fdfe

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

@10Derozan 10Derozan merged commit 4287616 into web-infra-dev:main Jun 30, 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