fix(docs): update README docs

[chilingling]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• Documentation
  • Updated local development setup instructions in the README.md and README.zh-CN.md files.
  • Removed leading $ symbol from commands.
  • Added a new build step (pnpm build:plugin) before starting the development server.
  • Included a note about the necessity of building the plugin before starting.

[coderabbitai]

Walkthrough

The recent updates to the README.md and README.zh-CN.md files refine the local development setup instructions. The changes streamline the process by removing unnecessary symbols from commands and adding a critical build step for a plugin before starting the development server. This ensures all necessary components are properly built, enhancing the overall development workflow.

Changes

File	Change Summary
README.md	Updated local dev setup: removed $ from commands, added plugin build step.
README.zh-CN.md	Introduced a plugin build step before starting the dev server for local setup.

🌸 In the realm of code, where devs do dwell,
A change was made, a tale to tell.
Commands now clear, without a fuss,
Build your plugins, join the bus!
With each new step, our workflow grows,
A smoother path, as everyone knows. 🚀

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[coderabbitai]

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 6d9241e and 0c08ba3.

Files selected for processing (2)

• README.md (1 hunks)
• README.zh-CN.md (1 hunks)

Additional Context Used

LanguageTool (2)

README.md (1)

Near line 101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...tribution If you are interested in our open source project, please join us! 🎉 Please rea...

README.zh-CN.md (1)

Near line 16: 数量词修饰并列短语，可能产生歧义
Context: ...持二次开发或被集成 - 直接生成可部署的源码，运行时无需引擎支撑 - 允许接入第三方组件、允许定制扩展插件 - 支持高代码与低代码，混合开发部署应用 - 平台接入 AI ...

Additional comments not posted (4)

README.zh-CN.md (2)

31-31: LGTM! Simplifying command prompts can help avoid confusion in copy-paste scenarios.

---

37-39: Good addition. Ensuring the plugin is built before starting the server can prevent runtime issues.

README.md (2)

31-31: LGTM! Simplifying command prompts can help avoid confusion in copy-paste scenarios.

---

37-39: Good addition. Ensuring the plugin is built before starting the server can prevent runtime issues.

[hexqi]

建议缩小范围，开发态没有必要每次启动都构建所有的插件