Skip to content

docs(IDE): add Eclipse Marketplace stuff and update installation steps#129

Merged
xijing21 merged 4 commits intoruyisdk:zhfrom
pzhlkj6612:ide/index
Feb 10, 2026
Merged

docs(IDE): add Eclipse Marketplace stuff and update installation steps#129
xijing21 merged 4 commits intoruyisdk:zhfrom
pzhlkj6612:ide/index

Conversation

@pzhlkj6612
Copy link
Copy Markdown
Contributor

@pzhlkj6612 pzhlkj6612 commented Feb 8, 2026

____ ____ _    _ ___  ____ ____    _  _ ____ ____ _  _ ____ ___ ___  _    ____ ____ ____ 
|___ |    |    | |__] [__  |___    |\/| |__| |__/ |_/  |___  |  |__] |    |__| |    |___ 
|___ |___ |___ | |    ___] |___    |  | |  | |  \ | \_ |___  |  |    |___ |  | |___ |___ 
                                                                                         

/cc: @xijing21

Summary by Sourcery

Update RuyiSDK IDE documentation to reflect Eclipse Marketplace-based plugin installation and clarify upgrade guidance for IDE and plugins.

Documentation:

  • Document Eclipse Marketplace as the recommended way to install the RuyiSDK IDE Eclipse plugin, replacing the previous plugin repository instructions.
  • Refresh IDE documentation wording and screenshots related to plugin installation and clarify workspace safety and upgrade recommendations for newer IDE and plugin versions.

Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 8, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the RuyiSDK IDE documentation to direct users to install the Eclipse plugin via Eclipse Marketplace instead of the GitHub releases page, refreshes the associated screenshot, and clarifies wording around integrated IDE packaging and update behavior.

Flow diagram for updated RuyiSDK IDE and plugin update behavior

flowchart TD
  A[Start with installed RuyiSDK IDE] --> B[Launch new IDE version or update RuyiSDK plugin]
  B --> C[Select existing workspace]
  C --> D[Continue development]
  D --> E[Benefit from latest bug fixes and new features]
Loading

File-Level Changes

Change Details Files
Update plugin installation instructions to use Eclipse Marketplace instead of direct GitHub release link, and refresh related wording and screenshot.
  • Change plugin installation link from the GitHub releases/tag/continuous page to the Eclipse Marketplace listing for the RuyiSDK plugin.
  • Replace the old plugin installation screenshot with a new screenshot showing the RuyiSDK entry in Eclipse Marketplace.
  • Tweak wording to say a more convenient installation method is coming, removing mention of "使用方式" to focus on installation only.
IDE/index.md
Clarify update behavior to cover both IDE and plugin updates and strengthen recommendation to stay on the latest IDE version for bug fixes and new features.
  • Extend the update note to mention both starting a new IDE version and updating the RuyiSDK plugin while reassuring users they can keep using the same workspace.
  • Adjust wording to emphasize that the docs are continuously updated and recommend always using the latest RuyiSDK IDE version for bug fixes and new features.
IDE/index.md

Possibly linked issues

  • #0: PR updates IDE main plugin installation section to new Eclipse Marketplace flow, directly addressing the documentation gap described

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • Consider formatting the Eclipse Marketplace URL as a proper Markdown link with descriptive text instead of a bare URL to improve readability and accessibility.
  • Double-check that the new screenshot filename image/eclipse-marketplace-ruyisdk.jpg exists in the repo and matches the actual file name and path to avoid broken images in the rendered docs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider formatting the Eclipse Marketplace URL as a proper Markdown link with descriptive text instead of a bare URL to improve readability and accessibility.
- Double-check that the new screenshot filename `image/eclipse-marketplace-ruyisdk.jpg` exists in the repo and matches the actual file name and path to avoid broken images in the rendered docs.

## Individual Comments

### Comment 1
<location> `IDE/index.md:37` </location>
<code_context>
+![eclipse-marketplace-ruyisdk](image/eclipse-marketplace-ruyisdk.jpg)

-目前我们正在完善整合了插件的 RuyiSDK IDE 工程,将很快提供更加便捷的安装和使用方式。
+目前我们正在完善整合了插件的 RuyiSDK IDE 工程,将很快提供更加便捷的安装方式。

 ## 案例
</code_context>

<issue_to_address>
**suggestion (typo):** “正在完善整合了插件的”这一结构略显别扭,可考虑优化表述以提高可读性。

这句话语法虽无误,但读起来略显拗口。建议改为“正在完善已整合插件的 RuyiSDK IDE 工程”或“正在完善集成插件的 RuyiSDK IDE 工程”,表达会更自然。

```suggestion
目前我们正在完善集成插件的 RuyiSDK IDE 工程,将很快提供更加便捷的安装方式。
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

CO-authored-by: sourcery-ai
Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@pzhlkj6612
Copy link
Copy Markdown
Contributor Author

The last successful build was based on https://github.com/ruyisdk/ruyisdk-website/tree/f779e7677e35e5b23d7be2f027fe906ae7abe304. Now the website is using pnpm and we should be waiting for #130 to be merged.

mpc: Eclipse Marketplace Client

Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@xijing21 xijing21 merged commit f57a6ff into ruyisdk:zh Feb 10, 2026
3 checks passed
@pzhlkj6612 pzhlkj6612 deleted the ide/index branch February 10, 2026 08:17
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