feat: add VSCode-Plugins/board-docs.mdx#139
Merged
Merged
Conversation
Signed-off-by: sisungo <sisungo@icloud.com>
Contributor
Reviewer's GuideAdds 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 Docsflowchart 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]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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 示例
+
+
+
+在示例首页中,按照品牌和型号选择你所需要的开发板。你将看到该开发板基本情况的描述,和可用的示例列表。
+
+
+
+点击示例列表中的示例即可查看一则示例文档。示例文档将会介绍如何在该型号的 RISC-V 开发板上运行示例,或进行其他开发操作,
+如多媒体处理、人工智能训练和推理。
+
+
+
+点击右上角的蓝色 “在 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 示例

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

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

```
</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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
添加 board-docs 文档
Summary by Sourcery
Documentation: