Skip to content

Supplement the openvela documentation #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tanghao-xiaomi merged 2 commits into from
Mar 31, 2025
Merged

Supplement the openvela documentation #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9d7405
Supplement the openvela documentation
tanghao-xiaomi Mar 31, 2025
b0da633
Supplement the openvela documentation
tanghao-xiaomi Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions zh-cn/contribute/process/doc_dev_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

如果你负责开发某一特性，你需要与文档团队一起配合，确保在版本发布之前完成该特性所配套文档的开发。否则，未提供配套文档的特性在发布时可能被移除。

1. 联系 [文档团队资料作者](doc_reviewer.md)，讨论文档设计。
2. 参考 [文档写作模板](../template)进行配套文档的写作。
1. 联系[文档团队资料作者](https://github.com/open-vela/docs/blob/dev/zh-cn/contribute/process/doc_reviewer.md)，讨论文档设计。
Copy link
Copy Markdown

@xiaoxiang781216 xiaoxiang781216 Mar 31, 2025

Choose a reason for hiding this comment

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

should we use the related path for gitee compatible

Copy link
Copy Markdown
Collaborator Author

@tanghao-xiaomi tanghao-xiaomi Mar 31, 2025

Choose a reason for hiding this comment

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

Currently, this is set up for document center navigation. In April, it will be reverted to relative paths, and the issue will be resolved through code.

2. 参考[文档写作模板](https://github.com/open-vela/docs/tree/dev/zh-cn/contribute/template)进行配套文档的写作。
3. 为功能特性撰写详细的文档初稿，提交 PR 并在描述中提供对应的需求 `Issue` 链接。

### 2 提交PR评审
Expand All @@ -29,7 +29,7 @@

- 建议自行翻译。
- 如需文档团队翻译，请在中文文档完成评审测试定稿后提交翻译需求。提交翻译需求时请配套提供以下信息：
1. 新增术语请补充至 [术语表](../../overview/glossary.md)。
1. 新增术语请补充至[术语表](../../overview/glossary.md)。
2. 英文截图。

## 文档工程师要做的
Expand Down
2 changes: 1 addition & 1 deletion ...dev_guide/kernal/inter_processor_communication/VirtIO/introduction_to_virtio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ struct vring {

#### 4.5 Virtqueue

Virtqueue 是 VirtIO 的核心组件之一，负责管理数据的传输队列。它通过与 vring 结构的结合，实现 Driver 和 Device 之间的高效通信。以下是 Virtqueue 的定义和关键字段说明。
Virtqueue 是 VirtIO 的核心组件之一，负责管理数据的传输队列。它通过与 Vring 结构的结合，实现 Driver 和 Device 之间的高效通信。以下是 Virtqueue 的定义和关键字段说明。

##### 数据结构定义

Expand Down