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: Update README-zh_CN.md to reflect Ant Design X #81

Merged
merged 3 commits into from
Aug 19, 2024

Conversation

zombieJ
Copy link
Member

@zombieJ zombieJ commented Aug 19, 2024

Update README-zh_CN.md and package.json to reflect Ant Design X.

  • README-zh_CN.md

    • Update title and description to reflect Ant Design X.
    • Replace all instances of Ant Design with Ant Design X.
    • Update badges and links to point to Ant Design X.
    • Update features to reflect Ant Design X capabilities.
    • Update installation instructions for Ant Design X.
    • Update usage examples to reflect Ant Design X components.
  • package.json

    • Update unpkg path to dist/antd-x.min.js.
    • Update size-limit path to dist/antd-x.min.js.

For more details, open the Copilot Workspace session.

Summary by CodeRabbit

  • New Features

    • Rebranding of the library from "antd" to "@ant-design/x," focusing on AI-driven interfaces and intelligent dialogue components.
    • Updated installation instructions and usage examples to reflect the new package name.
  • Documentation

    • Enhanced README to emphasize new functionalities and AI capabilities.
    • Consistent badge URLs for npm, GitHub actions, coverage, and download statistics following the rebranding.
  • Chores

    • Adjusted package.json entries for distribution paths to align with the new library name.

Update `README-zh_CN.md` and `package.json` to reflect Ant Design X.

* **README-zh_CN.md**
  - Update title and description to reflect Ant Design X.
  - Replace all instances of Ant Design with Ant Design X.
  - Update badges and links to point to Ant Design X.
  - Update features to reflect Ant Design X capabilities.
  - Update installation instructions for Ant Design X.
  - Update usage examples to reflect Ant Design X components.

* **package.json**
  - Update `unpkg` path to `dist/antd-x.min.js`.
  - Update `size-limit` path to `dist/antd-x.min.js`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ant-design/x?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The updates to the Ant Design X project signify a major rebranding from "antd" to "@ant-design/x," highlighting a new emphasis on AI-driven interfaces. Key modifications include streamlined installation instructions, enhanced feature descriptions, and adjustments to public entity declarations. The package.json file has also been updated to reflect new distribution paths, reinforcing the library's advanced capabilities and integrations with intelligent components.

Changes

Files Change Summary
README-zh_CN.md Rebranding from "antd" to "@ant-design/x"; updated installation commands, feature descriptions, and import statements.
package.json Updated unpkg entry and size-limit path from dist/antd.min.js to dist/antd-x.min.js.

Poem

🐇 In fields of code where rabbits play,
A brand new name has come our way.
"@ant-design/x" shines bright and clear,
For AI-driven dreams, we now hold dear.
With every update, our hopes do dance,
Let's hop with joy and take a chance! ✨


Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Aug 19, 2024

Preview is ready

Copy link

socket-security bot commented Aug 19, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@types/qs@6.9.15 None 0 7.34 kB types
npm/@types/semver@7.5.8 None 0 23.3 kB types
npm/dayjs@1.11.12 None 0 669 kB iamkun
npm/lz-string@1.5.0 None 0 176 kB pieroxy
npm/mockdate@3.0.5 None 0 13.8 kB boblauer
npm/typescript@5.5.4 None 0 21.9 MB typescript-bot

🚮 Removed packages: npm/@ant-design/colors@7.1.0, npm/@ant-design/cssinjs-utils@1.0.3, npm/@ant-design/cssinjs@1.21.0, npm/@ant-design/icons@5.4.0, npm/@ant-design/tools@18.0.2, npm/@babel/eslint-plugin@7.25.1, npm/@babel/runtime@7.25.0, npm/@biomejs/biome@1.8.3, npm/@codesandbox/sandpack-react@2.18.2, npm/@ctrl/tinycolor@4.1.0, npm/@ianvs/prettier-plugin-sort-imports@4.3.1, npm/@madccc/duplicate-package-checker-webpack-plugin@1.0.0, npm/@microflash/rehype-figure@2.1.0, npm/@npmcli/run-script@8.1.0, npm/@octokit/rest@21.0.2, npm/@qixian.cs/github-contributors-list@2.0.2, npm/@rc-component/trigger@2.2.1, npm/@size-limit/file@11.1.4, npm/@stackblitz/sdk@1.11.0, npm/@testing-library/dom@10.4.0, npm/@testing-library/jest-dom@6.4.8, npm/@testing-library/react@16.0.0, npm/@testing-library/user-event@14.5.2, npm/@types/adm-zip@0.5.5, npm/@types/ali-oss@6.16.11, npm/@types/cli-progress@3.11.6, npm/@types/fs-extra@11.0.4, npm/@types/gtag.js@0.0.20, npm/@types/http-server@0.12.4, npm/@types/inquirer@9.0.7, npm/@types/isomorphic-fetch@0.0.39, npm/@types/jest-axe@3.5.9, npm/@types/jest-environment-puppeteer@5.0.6, npm/@types/jest-image-snapshot@6.4.0, npm/@types/jest@29.5.12, npm/@types/jquery@3.5.30, npm/@types/jsdom@21.1.7, npm/@types/markdown-it@14.1.2, npm/@types/minimist@1.2.5, npm/antd@5.20.1, npm/classnames@2.5.1, npm/crypto@1.0.1, npm/jquery@3.7.1, npm/lodash@4.17.21, npm/minimist@1.2.8, npm/rc-util@5.43.0, npm/react-dom@18.3.1, npm/react@18.3.1

View full report↗︎

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5fe430 and 4be9733.

Files selected for processing (2)
  • README-zh_CN.md (5 hunks)
  • package.json (2 hunks)
Additional comments not posted (7)
README-zh_CN.md (5)

19-36: LGTM! Badge URLs and links updated correctly.

The badge URLs and links have been updated to reflect the new package name "@ant-design/x". Ensure that these links are functional and point to the correct resources.


51-51: LGTM! Features section updated to highlight AI capabilities.

The features section now emphasizes AI-driven interfaces, which aligns with the rebranding of Ant Design X.


71-79: LGTM! Installation instructions updated for consistency.

The installation commands for npm, yarn, and pnpm have been correctly updated to use "@ant-design/x".


86-86: LGTM! Import statement updated correctly.

The import statement now correctly uses "@ant-design/x", aligning with the rebranding.


104-104: LGTM! TypeScript usage note updated correctly.

The TypeScript usage note now references "@ant-design/x", maintaining clarity for users.

package.json (2)

37-37: LGTM! unpkg path updated correctly.

The unpkg path has been correctly updated to point to dist/antd-x.min.js, aligning with the rebranding.


307-307: LGTM! size-limit path updated correctly.

The size-limit path has been correctly updated to reflect dist/antd-x.min.js, ensuring size constraints are applied to the correct file.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4be9733 and f3944cd.

Files selected for processing (1)
  • README-zh_CN.md (5 hunks)
Additional comments not posted (5)
README-zh_CN.md (5)

7-7: LGTM! Introduction and badges updated correctly.

The introduction now highlights AI-driven interfaces, and all badge URLs and references have been updated to reflect the new package name. These changes are consistent and accurate.

Also applies to: 19-40


51-51: LGTM! Features section updated to reflect AI capabilities.

The features section now includes AI-driven capabilities, aligning with the strategic direction of the library.


71-79: LGTM! Installation commands updated correctly.

The installation instructions for npm, yarn, and pnpm have been updated to use @ant-design/x, ensuring consistency across package managers.


86-89: LGTM! Usage example updated correctly.

The import statement now reflects the new package name @ant-design/x and demonstrates the usage of the Bubble component, aligning with the rebranding.


101-101: LGTM! TypeScript usage note updated correctly.

The TypeScript usage note now correctly refers to @ant-design/x, maintaining consistency with the rest of the document.

@zombieJ zombieJ merged commit 8fbc1d7 into main Aug 19, 2024
6 checks passed
@zombieJ zombieJ deleted the zombieJ/update-readme-zh-cn branch August 19, 2024 08:39
Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.93%. Comparing base (f5fe430) to head (d93d97e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   98.93%   98.93%           
=======================================
  Files          26       26           
  Lines         377      377           
  Branches      108      109    +1     
=======================================
  Hits          373      373           
  Misses          4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

YumoImer pushed a commit that referenced this pull request Aug 19, 2024
* docs: Update README-zh_CN.md to reflect Ant Design X

Update `README-zh_CN.md` and `package.json` to reflect Ant Design X.

* **README-zh_CN.md**
  - Update title and description to reflect Ant Design X.
  - Replace all instances of Ant Design with Ant Design X.
  - Update badges and links to point to Ant Design X.
  - Update features to reflect Ant Design X capabilities.
  - Update installation instructions for Ant Design X.
  - Update usage examples to reflect Ant Design X components.

* **package.json**
  - Update `unpkg` path to `dist/antd-x.min.js`.
  - Update `size-limit` path to `dist/antd-x.min.js`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ant-design/x?shareId=XXXX-XXXX-XXXX-XXXX).

* Update README-zh_CN.md

* Update README-zh_CN.md
YumoImer added a commit that referenced this pull request Aug 30, 2024
* feat: Init component ThoughtChain

* docs: update docs and demo

* feat: Init component ThoughtChain

* docs: Update README-zh_CN.md to reflect Ant Design X (#81)

* docs: Update README-zh_CN.md to reflect Ant Design X

Update `README-zh_CN.md` and `package.json` to reflect Ant Design X.

* **README-zh_CN.md**
  - Update title and description to reflect Ant Design X.
  - Replace all instances of Ant Design with Ant Design X.
  - Update badges and links to point to Ant Design X.
  - Update features to reflect Ant Design X capabilities.
  - Update installation instructions for Ant Design X.
  - Update usage examples to reflect Ant Design X components.

* **package.json**
  - Update `unpkg` path to `dist/antd-x.min.js`.
  - Update `size-limit` path to `dist/antd-x.min.js`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ant-design/x?shareId=XXXX-XXXX-XXXX-XXXX).

* Update README-zh_CN.md

* Update README-zh_CN.md

* docs: Update README.md to reflect Ant Design X (#82)

Update `README.md` to reference "Ant Design X" instead of "Ant Design" and include "@ant-design/x".

* **Title and Description**
  - Change the title to "Ant Design X".
  - Update the description to "Crafting AI-driven interfaces with React, seamlessly integrating smart chat components and API services at your fingertips."

* **Installation Instructions**
  - Update the installation instructions to use "@ant-design/x".

* **Usage Example**
  - Update the usage example to use "@ant-design/x".

* **Links**
  - Update the links to point to the new repository and documentation for "Ant Design X".

* **Features**
  - Update the features section to match the content in `README-zh_CN.md`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ant-design/x?shareId=XXXX-XXXX-XXXX-XXXX).

* chore(dependencies): add rc-motion (#83)

* docs: update site favicons

* chore(dependencies): add rc-motion

* refactor: chain style and dom

* chore: delete unuse file

* refactor: style and dom

* docs: update basic use background color.

* refactor: default icon by index

* refactor: delete default status

* feat: add collapse motion for ThoughtChainItem

* feat: New Component - ThoughtChain

* refactor: optimization code

* refactor: fix js error

* chore: prettier

* feat: New Component ThoughtChain

* docs: Consider using markdown link syntax for URLs to improve readability.

* docs: update

* test: update

* test: update

* fix: ci rtl error

* fix: rtl

* chore: code prettier

* fix: tooltip placement

* fix: default css var key

* test: update

* fix: ci error

* test: remove unuse function

* docs: update

* docs: update

* docs: update

* refactor: footer dom and style

* chore: remove unuse code

* test: conv

---------

Co-authored-by: 二货爱吃白萝卜 <smith3816@gmail.com>
This was referenced Dec 9, 2024
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