Skip to content

docs(Ruyi Imager): Add information about Ruyi Imager - #149

Merged
xijing21 merged 1 commit into
ruyisdk:zhfrom
Glavo:ruyi-imager
Sep 20, 2026
Merged

xijing21 merged 1 commit into
ruyisdk:zhfrom
Glavo:ruyi-imager

Conversation

@Glavo

@Glavo Glavo commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Document Ruyi Imager as a graphical option for installing operating systems on RISC-V development boards.

New Features:

  • Add Chinese documentation for installing and using Ruyi Imager to flash operating system images for RISC-V development boards.

Enhancements:

  • Update the operating-system installation guidance to present Ruyi Imager alongside the command-line provisioning workflow.

Documentation:

  • Add a dedicated Ruyi Imager documentation section with supported packages, flashing steps, safety warnings, and project resources.

@sourcery-ai

sourcery-ai Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

本 PR 新增 Ruyi Imager 文档页面,介绍跨平台安装包、图形化镜像刷写流程及安全注意事项,并在入门页将其作为 Ruyi 包管理器之外的另一种系统部署方式,同时更新相关分类配置。

Flow diagram for Ruyi Imager image flashing

flowchart TD
    A[选择开发板和操作系统或打开本地镜像] --> B[连接存储卡或开发板]
    B --> C[选择目标设备]
    C --> D{确认镜像和设备}
    D -->|确认| E[开始刷写]
    D -->|取消| A
    E --> F[完成后按开发板文档启动系统]
    E --> G[刷写期间不要断开连接]
Loading

File-Level Changes

Change Details Files
新增 Ruyi Imager 的中文使用文档,涵盖安装、镜像刷写流程和相关资源。
  • 按操作系统与处理器架构列出安装包类型及下载入口
  • 说明选择镜像、目标设备和执行刷写的操作步骤
  • 增加数据覆盖、备份和避免断连等安全警告
  • 提供源码反馈页和站内下载页链接
Imager/index.md
Imager/_category_.json
在入门文档中补充图形化刷写路径,并明确区分命令行和图形界面方案。
  • 将原有刷写说明归类为 Ruyi 包管理器方式
  • 新增 Ruyi Imager 页面入口
intro.md
更新文档分类配置以纳入新增页面。
  • 调整 Other 和 legal 分类元数据
Other/_category_.json
legal/_category_.json

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

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

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="Imager/index.md" line_range="34" />
<code_context>
+
+## 相关资源
+
+- [项目源码与问题反馈](https://github.com/Glavo/ruyi-imager)
+- [下载页](/downloads#ruyi-imager)
</code_context>
<issue_to_address>
**issue:** “下载页”链接指向站点根路径 `/downloads#ruyi-imager`,但仓库中没有对应的 downloads 页面或 `ruyi-imager` 锚点,因此用户点击该链接会进入 404 页面或无法定位到下载内容。

**Triggers:** 当用户从 Ruyi Imager 文档底部点击“下载页”时。

**Suggested fix:** 改为直接链接到 GitHub Releases,或添加实际存在的下载页面及 `ruyi-imager` 锚点。

```suggestion
- [下载页](https://github.com/Glavo/ruyi-imager/releases/latest)
```
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: Imager/index.md:34


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread Imager/index.md Resolved

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sourcery assessment

Approved.

Signed-off-by: Glavo <glavo@isrc.iscas.ac.cn>
@xijing21
xijing21 merged commit 80e7bcc into ruyisdk:zh Sep 20, 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