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.md to reflect Ant Design X #82

Merged
merged 1 commit into from
Aug 19, 2024

Conversation

zombieJ
Copy link
Member

@zombieJ zombieJ commented Aug 19, 2024

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.

Summary by CodeRabbit

  • New Features

    • Rebranding of the project to "Ant Design X," emphasizing AI-driven interfaces and smart chat components.
    • Introduction of the new Bubble component, simplifying usage examples.
  • Documentation

    • Updated installation instructions and usage examples to reflect new package name @ant-design/x.
    • Modified links throughout the documentation to align with the rebranded project.

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).
Copy link

github-actions bot commented Aug 19, 2024

Preview is ready

Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The project has undergone a significant rebranding from "Ant Design" to "Ant Design X," shifting its focus towards AI-driven interfaces and smart chat components. This change is reflected across the README file, including updates to package names, installation instructions, and usage examples. The transition emphasizes a streamlined experience with the new Bubble component, enhancing user engagement with advanced functionalities.

Changes

Files Change Summary
README.md Rebranding from "Ant Design" to "Ant Design X"; updated package references, installation commands, and examples to feature Bubble instead of Button and DatePicker. Links changed to reflect new domain.

Poem

In a garden where ideas bloom,
Ant Design X clears the room.
With bubbles that dance and chat so bright,
AI's magic brings interfaces to light.
Hop along, dear coder friends,
New adventures await, where creativity never ends! 🐰✨


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.

@zombieJ zombieJ merged commit 04d275c into main Aug 19, 2024
6 checks passed
@zombieJ zombieJ deleted the zombieJ/update-readme branch August 19, 2024 08:54
Copy link
Contributor

@ONLY-yours ONLY-yours left a comment

Choose a reason for hiding this comment

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

+1

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 (8fbc1d7) to head (e9be63d).
Report is 1 commits behind head on main.

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

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

@@ -56,7 +56,7 @@ An enterprise-class UI design language and React UI library.

## ✨ Features

- 🌈 Enterprise-class UI designed for web applications.
- 🌈 Crafting AI-driven interfaces with React, seamlessly integrating smart chat components and API services at your fingertips.
- 📦 A set of high-quality React components out of the box.
- 🛡 Written in TypeScript with predictable static types.
- ⚙️ Whole package of design resources and development tools.
Copy link
Member

@afc163 afc163 Aug 19, 2024

Choose a reason for hiding this comment

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

下面其他几个特性对 AI 项目来说并不吸引人,最好重新写。

Copy link
Member

Choose a reason for hiding this comment

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

YumoImer pushed a commit that referenced this pull request Aug 19, 2024
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).
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.

4 participants