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

Update README.md #5124

Merged
merged 3 commits into from
Jul 29, 2024
Merged

Update README.md #5124

merged 3 commits into from
Jul 29, 2024

Conversation

ElricLiu
Copy link
Contributor

@ElricLiu ElricLiu commented Jul 29, 2024

Update redame,add Artifacts & SD

💻 变更类型 | Change Type

  • feat
  • fix
  • refactor
  • perf
  • style
  • test
  • docs
  • ci
  • chore
  • build

🔀 变更说明 | Description of Change

Update redame about artifacts & SD

📝 补充信息 | Additional Information

Summary by CodeRabbit

  • Documentation
    • Enhanced the README.md to explicitly include artifacts as a supported feature within the plugins section, improving clarity and usability.
    • Added a new version announcement (v2.14.0) highlighting support for artifacts and SD.

Update redame,add Artifacts & SD
Copy link

vercel bot commented Jul 29, 2024

@ElricLiu is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jul 29, 2024

Warning

Rate limit exceeded

@ElricLiu has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 39 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between d70d46b and 071391d.

Walkthrough

The recent updates to the documentation improve clarity around plugins and artifacts. Artifacts are now explicitly recognized as a distinct feature, enabling users to preview, copy, and share content more easily. This restructuring enhances usability by clearly separating artifacts from other plugin functionalities. The new version announcement (v2.14.0) underscores ongoing enhancements, offering users better insights into the software's capabilities.

Changes

Files Change Summary
README.md Enhanced documentation on plugins, explicitly including artifacts as a distinct feature, and updated version announcement (v2.14.0) highlighting support for artifacts and SD.

Poem

🐇 In a world where plugins play,
Artifacts come out to sway!
With a wink and a hop, they share,
Content made with love and care.
Version two point fourteen is here,
Let's cheer for changes, oh so dear! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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.

README.md Outdated
@@ -129,6 +136,7 @@ For enterprise inquiries, please contact: **[email protected]**
- 🚀 v2.7 现在可以将会话分享为图片了,也可以分享到 ShareGPT 的在线链接。
- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
- 🚀 v2.9.11 现在可以使用自定义 Azure 服务了。
- 🚀 v2.14.0 现在支持 Artifacts & SD 了
Copy link
Contributor

Choose a reason for hiding this comment

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

一边是顺序的,一边是倒序的。是不是统一一下?

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 35c5518 and 3ef596b.

Files selected for processing (1)
  • README.md (3 hunks)
Additional context used
Markdownlint
README.md

129-129: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)


130-130: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (3)
README.md (3)

91-91: LGTM!

The addition of artifacts to the roadmap is clear and well-formatted.


92-94: LGTM!

The addition of plugins to the roadmap is clear and well-formatted.


98-98: LGTM!

The new version announcement is clear and well-formatted.

Copy link
Contributor

Your build has completed!

Preview deployment

@lloydzhou lloydzhou merged commit 90e1fad into ChatGPTNextWeb:main Jul 29, 2024
1 of 2 checks passed
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: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3ef596b and d70d46b.

Files selected for processing (1)
  • README.md (2 hunks)
Additional context used
LanguageTool
README.md

[grammar] ~136-~136: The operating system from Apple is written “macOS”.
Context: ...zure 服务了。 - 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。 - 🚀 v2.7 现在可以将会话分享为图片了,也可以分...

(MAC_OS)

Markdownlint
README.md

129-129: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)


130-130: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (2)
README.md (2)

98-98: Ensure consistency in version announcements.

The new version announcement for v2.14.0 is clear, but ensure that the format is consistent with previous announcements.


134-134: Ensure consistency in version announcements.

The new version announcement for v2.14.0 is clear, but ensure that the format is consistent with previous announcements.


## 最新动态

- 🚀 v2.14.0 现在支持 Artifacts & SD 了
- 🚀 v2.9.11 现在可以使用自定义 Azure 服务了。
- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix grammatical issue: Use "macOS" instead of "MacOS."

The correct term for the operating system from Apple is "macOS."

- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
+ 🚀 v2.8 发布了横跨 Linux/Windows/macOS 的体积极小的客户端。
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
+ 🚀 v2.8 发布了横跨 Linux/Windows/macOS 的体积极小的客户端。
Tools
LanguageTool

[grammar] ~136-~136: The operating system from Apple is written “macOS”.
Context: ...zure 服务了。 - 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。 - 🚀 v2.7 现在可以将会话分享为图片了,也可以分...

(MAC_OS)

Comment on lines +127 to +130
- [x] Artifacts: 通过独立窗口,轻松预览、复制和分享生成的内容/可交互网页 [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] 插件机制,支持 artifacts,联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] artifacts
- [ ] 支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
Copy link
Contributor

Choose a reason for hiding this comment

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

Improve clarity and consistency in the development plan section.

The development plan section mentions artifacts and plugins but has inconsistent indentation and redundant entries for network search and calculator.

- [x] 插件机制,支持 artifacts,联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
-   - [x] artifacts
-   - [ ] 支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+ [x] 插件机制,支持 artifacts,联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+   - [x] Artifacts
+   - [ ] 联网搜索、计算器、调用其他平台 api
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [x] Artifacts: 通过独立窗口,轻松预览、复制和分享生成的内容/可交互网页 [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] 插件机制,支持 artifacts,联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] artifacts
- [ ] 支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] Artifacts: 通过独立窗口,轻松预览、复制和分享生成的内容/可交互网页 [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] 插件机制,支持 artifacts,联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] Artifacts
- [ ] 联网搜索、计算器、调用其他平台 api
Tools
Markdownlint

129-129: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)


130-130: Expected: 2; Actual: 3
Unordered list indentation

(MD007, ul-indent)

Comment on lines +91 to +94
- [x] Artifacts: Easily preview, copy and share generated content/webpages through a separate window [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] Plugins: support artifacts, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] artifacts
- [ ] network search, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
Copy link
Contributor

Choose a reason for hiding this comment

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

Improve clarity and consistency in the roadmap section.

The roadmap section mentions artifacts and plugins but has inconsistent indentation and redundant entries for network search and calculator.

- [x] Plugins: support artifacts, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
-   - [x] artifacts
-   - [ ] network search, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+ [x] Plugins: support artifacts, network search, calculator, and other APIs [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+   - [x] Artifacts
+   - [ ] Network search, calculator, and other APIs
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [x] Artifacts: Easily preview, copy and share generated content/webpages through a separate window [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] Plugins: support artifacts, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] artifacts
- [ ] network search, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] Artifacts: Easily preview, copy and share generated content/webpages through a separate window [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092)
- [x] Plugins: support artifacts, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
- [x] artifacts
- [ ] network search, network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+ [x] Plugins: support artifacts, network search, calculator, and other APIs [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165)
+ - [x] Artifacts
+ - [ ] Network search, calculator, and other APIs

@coderabbitai coderabbitai bot mentioned this pull request Nov 5, 2024
10 tasks
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