Skip to content

docs(dragon q8b): make UFS module hardware connection image overridable + q8b specific image#1937

Merged
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/q8b-ufs-module-board-img-20260720
Jul 20, 2026
Merged

docs(dragon q8b): make UFS module hardware connection image overridable + q8b specific image#1937
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/q8b-ufs-module-board-img-20260720

Conversation

@tangzz-radxa

Copy link
Copy Markdown
Contributor

Summary

把 Dragon Q8B「从 microSD 卡启动并将系统安装到 UFS」(no-ufs-reader) 教程里 UFS 模块的硬件连接图片替换为产品专用图,并把公共组件 _use_dd_ufs.mdx 里的图片改成可选参数,方便后续各产品传入自己的图,不影响其他教程。

改动

  • docs/common/radxa-os/install-system/_use_dd_ufs.mdxi18n/en/.../common/radxa-os/install-system/_use_dd_ufs.mdx
    • UFS 模块硬件连接图的 src 改为 props?.ufs_module_img ?? "默认图"
    • 保留原默认图作为 fallback,其他产品(dragon-q6a / orion-o6n / cubie-a7z / som-cm4 等)继续不传参,自动走默认图,行为不变。
  • docs/dragon/q8b/getting-started/install-system/ufs-system/no-ufs-reader.mdi18n/en/.../dragon/q8b/getting-started/install-system/ufs-system/no-ufs-reader.md
    • <InstallSystem> 调用里新增 ufs_module_img,指向新的 Dragon Q8B 专用图。
  • static/img/dragon/q8b/dragon-q8b-ufs-module-board.webp
    • 新增 Dragon Q8B 专用 UFS 模块硬件连接图(webp,已压缩)。

为什么这样改

/docs/common/radxa-os/install-system/_use_dd_ufs.mdx 是被多个产品教程共用的组件(dragon-q6a、orion-o6n、cubie-a7z、som-cm4、dragon-q8b 等),之前硬件连接图是固定写死的 /img/common/.../ufs-moudle-board.webp。如果直接把组件里的图换成 Q8B 的,会破坏其他产品;如果直接在外层 q8b 文件里 hard-code 一个 div 覆盖,又会让组件失去复用价值。

参考 docs/common/other-system/openwrt/_mainline-install.mdxprops?.rkdevtool_emmc_img ?? "默认图" 的可选参数模式,把图片改成可选 prop:

  • 上层调用方可选传入 ufs_module_img,传入则用传入的图;
  • 不传则走组件里现有的默认图;
  • 默认图 URL 与原值完全一致,因此未调用新 prop 的教程(q6a / o6n / a7z / cm4 等)显示内容与改动前完全一致。

影响范围

  • Dragon Q8B:硬件连接图片替换为新图。
  • 其他使用 _use_dd_ufs.mdx 的产品(dragon-q6a / orion-o6n / cubie-a7z / som-cm4):无变化,继续显示默认图。
  • 其他 UFS 相关教程(用 _use_etcher_ufs.mdx 等独立组件的)未受影响。

中英文同步

  • 修改了 docs/(中文)和 i18n/en/docusaurus-plugin-content-docs/current/(英文)的同一组对应文件,保持双语同步。
  • 新图片物理只放在 static/img/dragon/q8b/ 下;英文版在前端通过 /en/img/ 路径前缀访问同一文件,与仓库内其他 webp 资源一致。

自检

  • bash scripts/agent-doc-drift-guard.sh
  • bash scripts/agent-doc-lint.sh
  • bash scripts/agent-doc-translation-guard.sh
  • github_pr_guard.py check ✅(双语完整、无超 scope 风险,文件数与提交数合理)

来源

  • 来自售后技术支持群的需求,希望用更准确的 Q8B UFS 模块硬件连接图替换掉公共默认图。
  • 实现模式参考 _mainline-install.mdx 中已有的 rkdevtool_emmc_img 可选参数用法。

cc @hardware owner: 麻烦帮忙核对一下 Dragon Q8B 新的 UFS 模块硬件连接图是否准确,PR 合并前可以截图对比一下。

…le via prop

- Make the UFS module hardware connection image in _use_dd_ufs.mdx an
  optional prop (ufs_module_img) with the existing default image kept
  as fallback, so other tutorials (dragon-q6a, orion-o6n, cubie-a7z,
  som-cm4) keep showing the default image and are not affected.
- Add a Dragon Q8B specific UFS module board image and pass it through
  the new ufs_module_img prop on the q8b no-ufs-reader page (zh + en).
- Keep bilingual sync: both docs/ and i18n/en counterparts updated.
@tangzz-radxa
tangzz-radxa requested review from a team, RadxaYuntian, akgnah and xzuoqi as code owners July 20, 2026 02:10
@Milir-Radxa
Milir-Radxa merged commit 2bd1752 into radxa-docs:main Jul 20, 2026
3 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