Skip to content

docs(dragon/q6a): add rsdk-image container as second environment setup method#1795

Merged
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/q6a-rsdk-image-method
Jun 4, 2026
Merged

docs(dragon/q6a): add rsdk-image container as second environment setup method#1795
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/q6a-rsdk-image-method

Conversation

@tangzz-radxa
Copy link
Copy Markdown
Contributor

背景

docs.radxa.com/dragon/q6a/.../build-system/radxa-os 当前只提供一种环境搭建方式:DevContainer(VSCode + Dev Containers 扩展 + git clone rsdk 源码)。本次新增第二种方式:rsdk-image 预制 Docker 容器,给客户多一个选择。

资料来源:内部 Feishu wiki 教程(rsdk Docker 镜像使用说明)。本次合并范围由 owner 明确限定为:

  • 简介 / 前置要求 / 安装 rsdk-image / 运行 四块
  • 不引入 rsdk build CLI 命令,统一走现有 TUI 流程

主要变更

docs/common/radxa-os/build-system/_radxa_os.mdx(中英双版同步):

  • 使用前提 拆分为「通用 / 方式一额外 / 方式二额外」三档
  • 新增 「选择环境搭建方式」 一节,用 Tabs 在两种方式之间切换
    • 方式一:DevContainer:保留原 git clone + Reopen in Container 流程
    • 方式二:rsdk-image 容器(新):
      • 一句话简介 + 适用人群
      • 安装方式 A:通过 mirrors.hust.edu.cn/radxa-deb/rsdk-test/apt install rsdk-image
      • 安装方式 B:从 radxa-pkg/rsdk-image Releases 下载 deb 手动装
      • 运行:rsdk-image --name rsdkdocker rm -f rsdk 重建,传 -- <cmd> 模式
      • 进入容器后 git clone 源码再走下方编译流程
  • 编译 Radxa OS 章节保持不变(两种方式最终都走 TUI)
  • 新增 「常见问题」 章节:efi mount busy、方式一 DevContainer 速率限制、方式二容器启动失败

重要说明

  • rsdk-image 当前发布在 rsdk-test testing 源中,文档已明确标注,请评估使用风险
  • 仓库地址使用 https://github.com/radxa-pkg/rsdk-image/releases(请维护者确认此 org 拼写正确)
  • 中英双版均已同步,PR guard check 已通过:
    • 1 commit, 2 files changed
    • scope: docs/common/radxa-os(单一 scope)
    • bilingual: missing_en = [], missing_zh = []

测试建议

合并前建议由 review 同学在本地 pnpm start 验证:

  1. 切换 setup-method Tab 链接是否正常(URL hash)
  2. <Tabs> 内的中文标点 / 英文标点渲染
  3. rsdk-image 简介 + 安装 + 运行 流程是否通顺
  4. 整体移动端 / 桌面端排版

…p method

Add Method 2 (rsdk-image container) to the Radxa OS development page for
Dragon Q6A, alongside the existing DevContainer-based Method 1. Both
methods converge on the same `rsdk` TUI workflow for compiling Radxa OS.

Changes:
- Use Tabs to switch between the two setup methods
- Method 1: existing DevContainer flow (git clone + VSCode + Reopen)
- Method 2: install rsdk-image deb via apt source or manual download,
  then run `rsdk-image --name rsdk` to enter the prebuilt container
- Add a "常见问题" section covering efi mount busy, Method 1 DevContainer
  rate limit, and Method 2 container start failure

Source material: internal Feishu wiki tutorial for rsdk-image.
…lication

Docusaurus picks up all h2/h3/h4 headings for the right-side TOC,
including those inside <TabItem>. When both Method 1 and Method 2 use
`### xxx` sub-headings, the TOC shows duplicated entries from both
methods, which is confusing.

Replace the `### ` / `#### ` headings inside <TabItem> with bold
bullets (`- **xxx**`), following the existing convention in
`docs/accessories/storage/taco/getting-started/install-system/emmc-system.md`.

No content is changed; only the heading levels are flattened.
@Milir-Radxa Milir-Radxa merged commit c3bd75b into radxa-docs:main Jun 4, 2026
5 of 6 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