Skip to content

docs: restructure architecture docs into subdirectories and add axvis… - #1792

Merged
ZR233 merged 5 commits into
devfrom
doc
Aug 3, 2026
Merged

docs: restructure architecture docs into subdirectories and add axvis…#1792
ZR233 merged 5 commits into
devfrom
doc

Conversation

@Josen-B

@Josen-B Josen-B commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

…or emulated devices page

@mai-team-app mai-team-app 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.

本 PR 将 ArceOS、StarryOS、Axvisor 架构概览移入各自子目录,新增 Axvisor 模拟设备框架说明,并调整架构侧栏分类。实现本身只影响文档站点导航与页面 URL,不涉及 Rust crate、应用流程、系统 ABI、feature-development 或 syscall 语义;新增页面中的关键设备框架符号已与当前 virtualization/ 实现抽查核对。

阻塞问题

  • 页面迁移改变了三个概览页的默认路由,却未同步保留旧路由或更新引用,导致站点不能构建(内联意见已定位)。这不是孤立的历史链接:architecture/overview 和三个 development 页面都受到影响。

验证

  • python3 .../review_pr_helper.py test:7/7 通过;prepare-review 确认工作区 HEAD 为 1403766a049ddad35d8552635769666bd79f5191
  • git diff --check origin/dev...HEAD:通过。
  • 在按 docs/README.md / workflow 准备的 Node v24.12.0 环境执行 cd docs && yarn install --frozen-lockfile && yarn build:失败,Docusaurus 3.10.1 报告 6 条失效链接并以 exit 1 结束。
  • 当前 PR head 没有组织 CI check run(total_count=0),因此没有可替代本地文档构建的通过结果;该失败由本 PR 的路由迁移直接造成。

既有讨论与重叠

  • 当前没有既有 review、行内评论或 issue 评论需要处理。
  • 已检查基线中现有 device-framework 实现以及以 architecture docsemulated devicesarchitecture/arceos 为关键词的开放 PR;未发现独立的重复/依赖实现。

待办审计

  • 文档移动、导航、链接、Docusaurus 构建及重叠分析均已完成;应用运行、QEMU/test-suit、Cargo 元数据、Rust clippy/fmt/test、feature-development、syscall 和冲突修复不适用,因为本 PR 仅变更 docs/ 内容。
  • 请修复旧路由兼容性或所有引用后,在 Node 24 环境重新运行 yarn build。除此之外未发现额外的实现风险。

Powered by gpt-5.6-terra

@@ -1,6 +1,6 @@
---

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.

阻塞|文档兼容性: 这里将页面移入 arceos/overview.md 后,默认路由会从 /docs/architecture/arceos 变为 /docs/architecture/arceos/overview。仓库内 docs/docs/development/arceos.md 仍在第 5、643 行链接旧地址,站点中会出现 404;StarryOS 和 Axvisor 也有同样的旧链接。请为迁移页面保留旧 slug/重定向,或在同一 PR 更新全部引用,并以 Docusaurus build 验证。

@Josen-B
Josen-B requested a review from ZCShou July 31, 2026 03:24

@mai-team-app mai-team-app 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.

本 PR 将 ArceOS、StarryOS、Axvisor 架构概览迁入子目录,新增 Axvisor 模拟设备框架说明,并调整架构侧栏分类。页面路由已通过三个 slug 保持为原地址,因此现有 development 页面链接仍然有效;本次变更仅影响文档站点,不涉及 Rust crate、应用流程、系统 ABI、feature-development 或 Starry syscall 语义。

阻塞问题

  • 新增模拟设备文档的服务注册章节引用了不存在的 services.rs 源文件,内联意见已定位;请改为实际 service.rs 模块,保证文档提供的维护审计入口可用。

验证与 CI

  • python3 /tmp/review_pr_helper.py test:7/7 通过;prepare-review 已确认工作区 HEAD 为 a31f6a3b1e9d4afe1996df7852a46f6bb6de0134
  • git diff --check origin/dev...HEAD:通过。
  • docs/README.md 和组织 .github/workflows/docs.yml 的 Node 24 环境执行 cd docs && yarn install --frozen-lockfile && yarn build:通过,生成 docs/build;该构建也覆盖了迁移后的路由与 Markdown 链接检查。
  • 当前 PR head 在组织仓库没有 check run(total_count=0,commit status 也无具体状态),因此无可替代本地构建的远端 CI 结果;未发现 PR 引入的 CI 失败。

既有意见、重叠与范围

  • 已检查上一轮关于概览页路由的意见:当前三个 overview 页均新增对应 slug,Docusaurus 构建通过,故该问题在当前 head 已解决。
  • 基线实现和以 architecture docsemulated devicesarchitecture/arceos 搜索到的开放 PR 已核对;未发现独立重复、依赖或冲突的实现。
  • 已抽查新页面涉及的 DeviceRuntime、factory、grant 和 service 模块;除上述错误锚点外,改动与当前 virtualization/ 实现一致。

待办审计

  • 已完成:基线约束/代码质量规范、PR 元数据与历史意见、逐文件文档/导航/链接审查、源码锚点核对、Docusaurus 构建、CI 与重叠分析、HEAD 复核。
  • 不适用:应用或 QEMU 运行、test-suit、Cargo fmt/clippy/test、Cargo 元数据检查、feature-development、syscall 语义及冲突修复;原因是本 PR 仅变更 docs/
  • 其余未发现阻塞风险。

Powered by gpt-5.6-terra


### 服务注册

`DeviceServices` 是设备贡献协作能力的类型化 registry,定义在 `virtualization/axdevice/src/services.rs` 并由 `DeviceBundle::with_service()` 写入。调用方通过 `ServiceKey` 查询明确的 trait service,而不是在生产路径中对 `Arc<dyn Device>` 做 downcast。

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.

阻塞|文档准确性: 此处及下方表格把 DeviceServices / ServiceKey 的代码锚点写成了 virtualization/axdevice/src/services.rs,但仓库中实际模块是单数的 virtualization/axdevice/src/service.rslib.rs 也从该模块 re-export)。新页面将这些路径作为维护审计入口,当前所有 services.rs 引用都会把读者带到不存在的文件。请改为实际模块路径并重新执行 yarn build

@mai-team-app mai-team-app 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.

本 PR 将 ArceOS、StarryOS、Axvisor 架构概览迁入子目录,新增 Axvisor 模拟设备框架说明,并调整架构分类导航。三个 overview 页通过 slug 保持原有 URL;新增页面的 17 个 virtualization/ 源码锚点均已与当前实现核对,文档与 DeviceRuntime、factory、grant、service 及 VM prepare 路径一致。改动仅限 docs/,不涉及 Rust crate、应用流程、系统 ABI、feature-development 或 Starry syscall 语义。

验证与 CI

  • python3 /tmp/review_pr_helper.py test:7/7 通过;prepare-review 和提交前复核均确认 HEAD 为 6e5b8e87079ad0c03c8ab9490a362f4e5de64429
  • git diff --check origin/dev...HEAD:通过,工作区干净。
  • 依照 docs/README.md 与组织 .github/workflows/docs.yml,在 Node v24.12.0 环境执行 cd docs && yarn install --frozen-lockfile && yarn build:通过,生成 docs/build
  • 当前 head 在组织仓库的 check runs 和 Actions workflow runs 均为 0;没有失败 CI,故本地 Docusaurus 构建作为针对性验证。

既有意见、范围与重叠

  • 上一轮关于旧路由的意见已由三个 slug 解决,站点构建确认历史链接可解析;services.rs 路径意见也已改为实际 service.rs,相关源码锚点存在。
  • 已检查默认分支的架构文档及设备框架实现,并以 architecture docsemulated devicesarchitecture/arceos 检索开放 PR;未发现重复、依赖或冲突实现。
  • 不适用:应用/QEMU、test-suit、Cargo fmt/clippy/test、Cargo 元数据、feature-development、syscall 语义、冲突修复;原因是变更仅为文档站点内容。

待办审计
路由、导航、链接、源码锚点、文档构建、CI、既有意见和重叠分析均已完成,未发现未解决风险或测试缺口。

Powered by gpt-5.6-terra

@mai-team-app mai-team-app 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.

本 PR 将 ArceOS、StarryOS、Axvisor 的架构概览迁入各自子目录,新增 Axvisor 模拟设备框架说明,并调整架构分类导航。三个 overview 页通过 slug 保持原有 URL;新增页面涉及的 DeviceRuntime、factory、grant、service 与 VM prepare 路径已与当前 virtualization/ 实现抽查核对,未发现文档与实现不一致。

范围与既有意见

  • 改动仅限 docs/,不会改动 Rust crate、应用工作流、系统 ABI 或运行时行为;因此 feature-development、Starry syscall、Cargo fmt/clippy/test、Cargo 元数据、QEMU/app/test-suit 与冲突修复均不适用。
  • 已复核既有意见:概览页旧路由已由三个 slug 保持,services.rs 已更正为实际的 service.rs;本次 Docusaurus 构建确认链接可解析。

验证与 CI

  • python3 /tmp/.mai-team/skills/system/reviewer-agent-review-pr/scripts/review_pr_helper.py test:7/7 通过。
  • prepare-review --repo /workspace/repo --pr 1792 --head-sha e4206418101ce58a0905f7aaefc571223e8a0b02 --base-ref origin/dev、提交前 HEAD 复核及 git diff --check origin/dev...HEAD:通过。
  • docs/README.md 和组织 .github/workflows/docs.yml 的 Node v24.12.0 环境执行 cd docs && yarn install --frozen-lockfile && yarn build:通过,生成 docs/build
  • 当前 head 在组织仓库的 check runs 与 Actions workflow runs 均为 0,没有可归因于本 PR 的失败 CI;以上本地 Docusaurus 构建覆盖本次文档路由和 Markdown 链接变更。

重叠与待办审计

  • 已检查默认分支的架构文档/设备框架实现,并以 architecture docsemulated devicesarchitecture/arceos 检索开放 PR;未发现重复、依赖或冲突实现。
  • 当前 head 的路由、导航、链接、源码锚点、文档构建、CI、既有意见和重叠分析均已完成;没有遗留风险或测试缺口。

批准合并。

Powered by gpt-5.6-terra

@mai-team-app mai-team-app 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.

本 PR 将 ArceOS、StarryOS、Axvisor 的架构概览迁入子目录,保留三个原有 URL 的 slug,并新增 Axvisor 模拟设备框架说明及对应分类导航。变更仅涉及文档站点;不改变 Rust crate、应用运行流程、系统 ABI 或 StarryOS syscall 语义,且与现有 virtualization/ 中的 DeviceRuntime、factory、grant、service 和 VM prepare 实现一致。

验证与 CI

  • python3 /tmp/.mai-team/skills/system/reviewer-agent-review-pr/scripts/review_pr_helper.py test:7/7 通过;提交前 prepare-reviewgit diff --check origin/dev...HEAD 和工作区清洁检查均通过,HEAD 已复核为 fa4beb7c60a88d9df8e6c3f14275d47c5151967e
  • docs/README.md.github/workflows/docs.yml 安装 Node v24.12.0 后,执行 cd docs && yarn install --frozen-lockfile && yarn build 成功,生成 docs/build
  • 组织当前 head 的唯一 check 为 CI Branch Push Router / Route branch push CI,结论 success;其配置对 docs/** 使用 path-ignore,未执行文档构建,因此以上本地 Docusaurus 构建是必要且针对性的补充。没有发现 PR 引入的 CI 失败。

既有意见、范围与重叠

  • 已复核两项历史阻塞意见:三个 overview 页的 slug 使既有 development 链接继续解析;services.rs 已更正为实际的 service.rs。当前构建与源码锚点检查均确认两项问题已解决。
  • 已核对默认分支现有架构文档/设备框架,并以 architecture docsemulated devicesaxdeviceaxvisor documentation 检索开放 PR;未发现重复、依赖或冲突的实现。
  • 文档链接、分类 JSON、导航顺序及 591 行新增页面引用的源码路径/关键标识符均已检查,未发现遗留风险或测试缺口。

待办审计

  • 已完成:范围与 HEAD 核对、基线约束和代码质量规范、迁移页面/旧 URL/导航/源码锚点审查、历史意见、CI/重叠分析及文档构建。
  • 不适用:feature-development、syscall 语义、Cargo fmt/clippy/test、Cargo 元数据、应用/QEMU/test-suit 运行、冲突修复;原因是 PR 仅变更 docs/,未新增运行时行为或 Rust 代码。
  • 无未完成的阻塞项。

Powered by gpt-5.6-terra

@ZR233
ZR233 merged commit f1774c1 into dev Aug 3, 2026
1 check passed
@ZR233
ZR233 deleted the doc branch August 3, 2026 07:50
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