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: add codefuse ide to getting started #4321

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Conversation

hacke2
Copy link
Member

@hacke2 hacke2 commented Jan 15, 2025

Types

  • 📚 Documentation Changes

Background or solution

Changelog

Summary by CodeRabbit

  • 文档更新
    • 更新了中文(简体)README 文件中的起步项目列表
    • 添加了 CodeFuse IDE 和 CodeBlitz 项目
    • 修改了现有项目条目的描述
    • 在英文 README 中添加了 CodeFuse IDE 链接

@hacke2 hacke2 requested review from erha19 and Ricbet January 15, 2025 05:42
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

概述

遍历

此次更改主要涉及 README-zh_CN.mdREADME.md 两个文件的更新。在中文版自述文件中,"起步项目"部分的项目列表进行了修改和扩充,包括更新现有项目描述和新增两个项目条目。英文版自述文件则在"Getting Started"部分新增了一个指向 CodeFuse IDE 的链接。

变更

文件 变更摘要
README-zh_CN.md - 更新 "Desktop IDE" 描述为 "桌面端 IDE"
- 更新 "Lite Web IDE" 描述为 "无容器 IDE"
- 新增 "CodeFuse IDE - 基于 OpenSumi 的 AI IDE"
- 新增 "CodeBlitz - 无容器 IDE 框架"
- 更新 "小程序 IDE" 条目
README.md - 在 "Getting Started" 部分新增 CodeFuse IDE 链接

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (1)
README-zh_CN.md (1)

56-60: 修复链接文本中的空格问题

根据 Markdown 规范,链接文本末尾不应该包含空格。

请应用以下修改:

- [Lite Web IDE - 无容器 IDE ](https://github.com/opensumi/ide-startup-lite)
+ [Lite Web IDE - 无容器 IDE](https://github.com/opensumi/ide-startup-lite)
- [小程序 IDE ](https://github.com/opensumi/app-desktop)
+ [小程序 IDE](https://github.com/opensumi/app-desktop)
🧰 Tools
🪛 Markdownlint (0.37.0)

59-59: null
Spaces inside link text

(MD039, no-space-in-links)


60-60: null
Spaces inside link text

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 543c6a8 and ffbe2c2.

📒 Files selected for processing (2)
  • README-zh_CN.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README-zh_CN.md

59-59: null
Spaces inside link text

(MD039, no-space-in-links)


60-60: null
Spaces inside link text

(MD039, no-space-in-links)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: build-windows
🔇 Additional comments (2)
README-zh_CN.md (1)

56-58: 很好的本地化处理!

新增的项目条目在中英文版本中保持了一致性,同时对描述进行了恰当的本地化处理。

README.md (1)

57-57: 新增项目条目符合文档风格!

新增的 CodeFuse IDE 条目与文档现有格式保持一致,并提供了清晰的描述。

@Ricbet Ricbet merged commit 3f08ffd into main Jan 16, 2025
8 checks passed
@Ricbet Ricbet deleted the docs/add-codefuse-ide branch January 16, 2025 02:40
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