doc: Update README.md docs

[hustcer]

doc: Update README.md docs

Summary by CodeRabbit

• Documentation
  • Improved the clarity and organization of the GitHub Action input parameters.
  • Revised descriptions to include explicit default values and clearer headings in both English and Chinese documentation.

[coderabbitai]

Walkthrough

The documentation for the GitHub Action has been updated in both the English and Chinese README files. The "Inputs" section tables were reformatted by removing the separate "Required" column and incorporating default values directly into the parameter descriptions. The text for each parameter (including version, check-latest, enable-plugins, features, and github-token) was revised for improved clarity without altering the underlying functionality.

Changes

Files	Change Summary
README.md, README.zh-CN.md	Updated "Inputs" section: reformatted table layout by removing the "Required" column and integrating default values into descriptions; clarified parameter details for version, check-latest, enable-plugins, features, and github-token.

Poem

I'm a bunny of the docs, so bold,
Hopping through parameters new and old.
Clarity blooms in every line,
Default values now perfectly shine.
With a skip and a joyful leap,
I celebrate changes that we all can keep! 🐰✨

---

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

[github-actions]

The changes in the README files are primarily documentation updates, focusing on improving the clarity and formatting of the input parameters table. Here are some observations and suggestions:

Observations:

1. Formatting Consistency:

   • The new format removes the "Required" column and integrates the optionality and default values directly into the description. This is a good change as it reduces redundancy and makes the table more concise.
   • The type information is now more prominently displayed, which is helpful for users.

2. Language Consistency:

   • The English (README.md) and Chinese (README.zh-CN.md) versions are consistent in their updates, which is important for maintaining clarity across different language versions.

3. Clarity Improvements:

   • The descriptions are more detailed and include default values directly in the description, which is a good practice for documentation.

Suggestions:

1. Default Value Formatting:

   • In the English version, the default value for version is written as \*, which might be a typo or formatting issue. It should be * (without the backslash) to match the actual default value.
   • Similarly, in the Chinese version, the default value for version is written as *, which is correct.

2. Type Formatting:

   • In the English version, the type for enable-plugins is written as bool \| string. The space before and after the pipe (|) is unnecessary and could be removed for consistency: bool|string.
   • The Chinese version correctly formats this as bool\|string.

3. Description Clarity:

   • The description for features in both versions could be slightly improved for clarity. Specifically, the phrase "and was removed after v0.93.1" could be rephrased to "and was removed starting from v0.93.1" to make it clearer that v0.93.1 is the version where the feature was removed.

Recommendations:

• Correct Default Value Formatting:

  • Update the default value for version in the English version to * (without the backslash).

• Type Formatting:

  • Remove the spaces around the pipe in the type for enable-plugins in the English version: bool|string.

• Description Improvement:

  • Rephrase the description for features to clarify the version where the feature was removed: "and was removed starting from v0.93.1".

Final Thoughts:

The changes are generally positive, improving the clarity and readability of the documentation. With the minor adjustments suggested above, the documentation will be even more user-friendly and consistent.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

169-176: Enhanced Input Parameters Table Layout
The reformatted table clearly conveys each input parameter's purpose, type, and default value. The consolidation of parameter details into the description column improves readability and aligns with the changes made in the Chinese version.
Consider varying the phrasing in similar descriptions (for instance, the repeated use of "Optional, Set to true ...") to add linguistic variety.

🧰 Tools

🪛 LanguageTool

[style] ~173-~173: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ring | Optional, Set totrue` if you want to register the bundled plugins or a comma...

(REP_WANT_TO_VB)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82f8792 and 8927cfd.

📒 Files selected for processing (2)

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

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~173-~173: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ring | Optional, Set totrue` if you want to register the bundled plugins or a comma...

(REP_WANT_TO_VB)

🔇 Additional comments (1)

README.zh-CN.md (1)

162-168: Clear and Consistent Input Parameters Table Formatting
The updated table now accurately specifies each parameter's type, description, and default value in one consolidated view. The use of escaped characters (e.g. bool\|string) ensures correct rendering and clarity.