Skip to content

feat: add VSCode-Plugins/board-docs.mdx#139

Merged
xijing21 merged 1 commit into
ruyisdk:zhfrom
sisungo:zh
May 25, 2026
Merged

feat: add VSCode-Plugins/board-docs.mdx#139
xijing21 merged 1 commit into
ruyisdk:zhfrom
sisungo:zh

Conversation

@sisungo
Copy link
Copy Markdown
Contributor

@sisungo sisungo commented May 23, 2026

添加 board-docs 文档

Summary by Sourcery

Documentation:

  • Document how to open and use RuyiSDK board example docs from the VSCode extension, including viewing board guides and sending example prompts to Copilot.

Signed-off-by: sisungo <sisungo@icloud.com>
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 23, 2026

Reviewer's Guide

Adds a new VSCode plugin documentation page describing how to use the RuyiSDK Examples / Board Docs feature, including entry points, usage flow, and screenshots.

Flow diagram for using RuyiSDK Examples / Board Docs

flowchart TD
  A[Open VSCode] --> B[Open RuyiSDK Examples]
  B -->|Command palette ruyi.board-docs| C[Examples home]
  B -->|Extension home entry| C
  C --> D[Select board brand]
  D --> E[Select board model]
  E --> F[View board overview and examples list]
  F --> G[Click an example]
  G --> H[View example document]
  H --> I[Click blue button 在VSCode中打开]
  I --> J[Document and prompts filled into Copilot chat]
Loading

File-Level Changes

Change Details Files
Introduce a new MDX documentation page for the RuyiSDK Examples / Board Docs feature in the VSCode plugin docs.
  • Create a new MDX file with frontmatter configuring its sidebar position in the VSCode-Plugins docs section.
  • Document how to open the RuyiSDK Examples view via the VSCode command palette or extension home page.
  • Explain the workflow for selecting a RISC-V development board and viewing its example documentation, including multimedia and AI examples.
  • Describe the "Open in VSCode" action that sends the selected documentation and prompts into the Copilot chat for automated operations.
  • Embed three illustrative screenshots showing the examples home page, example selection, and example detail view.
VSCode-Plugins/board-docs.mdx

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 2 issues, and left some high level feedback:

  • The three images all use the generic alt text alt text; consider replacing these with short, descriptive phrases (e.g., explaining what is shown in each screenshot) to improve clarity and accessibility.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The three images all use the generic alt text `alt text`; consider replacing these with short, descriptive phrases (e.g., explaining what is shown in each screenshot) to improve clarity and accessibility.

## Individual Comments

### Comment 1
<location path="VSCode-Plugins/board-docs.mdx" line_range="19-30" />
<code_context>
+
+## 2. 如何使用 RuyiSDK 示例
+
+![alt text](./image/image-12.png)
+
+在示例首页中,按照品牌和型号选择你所需要的开发板。你将看到该开发板基本情况的描述,和可用的示例列表。
+
+![alt text](./image/image-13.png)
+
+点击示例列表中的示例即可查看一则示例文档。示例文档将会介绍如何在该型号的 RISC-V 开发板上运行示例,或进行其他开发操作,
+如多媒体处理、人工智能训练和推理。
+
+![alt text](./image/image-14.png)
+
+点击右上角的蓝色 “在 VSCode 中打开”,将会自动将文档和相关 Prompt 填充到 Copilot 聊天框中,便于使用 Copilot 自动化操作。
</code_context>
<issue_to_address>
**suggestion:** Use more descriptive alt text for accessibility and clarity.

Using the same generic `alt text` for all images doesn’t support screen readers or users when images fail to load. Please give each image a brief, specific description, e.g. `RuyiSDK 示例首页界面`, `开发板示例列表界面`, and `在 VSCode 中打开按钮示意` (and English equivalents if you want this doc to remain bilingual).

```suggestion
## 2. 如何使用 RuyiSDK 示例

![RuyiSDK 示例首页界面 / RuyiSDK examples home page](./image/image-12.png)

在示例首页中,按照品牌和型号选择你所需要的开发板。你将看到该开发板基本情况的描述,和可用的示例列表。

![开发板示例列表界面 / Development board examples list view](./image/image-13.png)

点击示例列表中的示例即可查看一则示例文档。示例文档将会介绍如何在该型号的 RISC-V 开发板上运行示例,或进行其他开发操作,
如多媒体处理、人工智能训练和推理。

![在 VSCode 中打开按钮示意 / “Open in VS Code” button example](./image/image-14.png)
```
</issue_to_address>

### Comment 2
<location path="VSCode-Plugins/board-docs.mdx" line_range="17-19" />
<code_context>
+- 在 VSCode 命令面板输入 `ruyi.board-docs`
+- 在扩展首页打开 RuyiSDK 示例
+
+注意,使用该功能依赖于有效的互联网连接。
+
+## 2. 如何使用 RuyiSDK 示例
</code_context>
<issue_to_address>
**suggestion:** Clarify behavior or error state when internet connectivity is unavailable.

Consider briefly describing what users will see when the internet is unavailable (e.g., specific error message, empty results, or retry option) so they understand the feature is blocked by connectivity rather than broken.

```suggestion
注意,使用该功能依赖于有效的互联网连接。
如果当前网络不可用或访问受限,示例列表与文档内容将无法加载,扩展可能会显示加载失败或网络错误提示,请先确认网络连接后再重试。

## 2. 如何使用 RuyiSDK 示例
```
</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 VSCode-Plugins/board-docs.mdx
Comment thread VSCode-Plugins/board-docs.mdx
@xijing21 xijing21 merged commit 9a759ec 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