Skip to content

docs(IDE): 直接使用 Update Site 网站或 zip 包#140

Merged
xijing21 merged 2 commits into
ruyisdk:zhfrom
pzhlkj6612:ide/no-marketplace-use-update-site
May 25, 2026
Merged

docs(IDE): 直接使用 Update Site 网站或 zip 包#140
xijing21 merged 2 commits into
ruyisdk:zhfrom
pzhlkj6612:ide/no-marketplace-use-update-site

Conversation

@pzhlkj6612
Copy link
Copy Markdown
Contributor

@pzhlkj6612 pzhlkj6612 commented May 25, 2026

See also:

Summary by Sourcery

Document online and offline installation methods for the RuyiSDK IDE Eclipse plugin using the Update Site URL and downloadable ZIP packages.

Documentation:

  • Add step-by-step instructions and screenshots for installing the RuyiSDK IDE plugin via an online Update Site repository.
  • Add step-by-step instructions and screenshots for offline installation of the RuyiSDK IDE plugin from a pre-downloaded ZIP package.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 25, 2026

Reviewer's Guide

Updates the IDE documentation to describe installing the RuyiSDK Eclipse plugin via an Update Site (online and offline using a ZIP archive), replacing the previous Eclipse Marketplace-based instructions and adding new screenshots and links.

File-Level Changes

Change Details Files
Replace Eclipse Marketplace-based installation instructions with Update Site-based online installation flow, including new repository configuration and update guidance.
  • Explain that RuyiSDK IDE plugin installation now has online and offline options.
  • Describe using 'Install New Software...' with a new 'RuyiSDK Updates (GitHub)' repository URL.
  • Add step to select the 'RuyiSDK IDE' feature and proceed with installation.
  • Document that future plugin upgrades can be done via 'Help' -> 'Check for Updates'.
IDE/index.md
Add offline installation instructions using a downloadable update-site ZIP archive from GitHub Releases, with supporting screenshots.
  • Describe downloading the versioned ruyisdk-eclipse-plugins ZIP from GitHub Releases.
  • Explain adding the ZIP via 'Archive...' in the 'Add Repository' dialog and installing the 'RuyiSDK IDE' feature.
  • Document the need to re-download and reinstall from the latest ZIP for future upgrades.
  • Insert multiple new screenshots illustrating online/offline install steps and ZIP selection.
IDE/index.md

Possibly linked issues


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:

  • The offline install section hardcodes version 0.1.4 as an example while also using <版本号>; consider emphasizing that the filename is just an example (e.g., via consistent placeholder text) to avoid users mistakenly looking for that specific version only.
  • The online and offline installation sections repeat very similar Eclipse UI steps; you might simplify future maintenance by briefly describing shared steps once and only calling out the differences (Update Site URL vs Archive zip) in each subsection.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The offline install section hardcodes version 0.1.4 as an example while also using `<版本号>`; consider emphasizing that the filename is just an example (e.g., via consistent placeholder text) to avoid users mistakenly looking for that specific version only.
- The online and offline installation sections repeat very similar Eclipse UI steps; you might simplify future maintenance by briefly describing shared steps once and only calling out the differences (Update Site URL vs Archive zip) in each subsection.

## Individual Comments

### Comment 1
<location path="IDE/index.md" line_range="64" />
<code_context>
+
+![ruyisdk-ide-eclipse-update-site-offline-2-select-feature](image/ruyisdk-ide-eclipse-update-site-offline-2-select-feature.jpg)
+
+将来若需要升级插件,请下载最新的版本的 zip 包并重复上述步骤。

 ## 案例
</code_context>
<issue_to_address>
**suggestion (typo):** Simplify “最新的版本的 zip 包” to avoid the double “的”.

Consider rephrasing this as “最新版本的 zip 包” for more natural and concise wording.

```suggestion
将来若需要升级插件,请下载最新版本的 zip 包并重复上述步骤。
```
</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.

Comment thread IDE/index.md Outdated
Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@xijing21 xijing21 merged commit e4d87d3 into ruyisdk:zh May 25, 2026
3 checks passed
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