docs(dragon q8b): make UFS module hardware connection image overridable + q8b specific image#1937
Merged
Milir-Radxa merged 1 commit intoJul 20, 2026
Conversation
…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
requested review from
a team,
RadxaYuntian,
akgnah and
xzuoqi
as code owners
July 20, 2026 02:10
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.
Summary
把 Dragon Q8B「从 microSD 卡启动并将系统安装到 UFS」(no-ufs-reader) 教程里 UFS 模块的硬件连接图片替换为产品专用图,并把公共组件
_use_dd_ufs.mdx里的图片改成可选参数,方便后续各产品传入自己的图,不影响其他教程。改动
docs/common/radxa-os/install-system/_use_dd_ufs.mdx和i18n/en/.../common/radxa-os/install-system/_use_dd_ufs.mdxsrc改为props?.ufs_module_img ?? "默认图"docs/dragon/q8b/getting-started/install-system/ufs-system/no-ufs-reader.md和i18n/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为什么这样改
/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.mdx里props?.rkdevtool_emmc_img ?? "默认图"的可选参数模式,把图片改成可选 prop:ufs_module_img,传入则用传入的图;影响范围
_use_dd_ufs.mdx的产品(dragon-q6a / orion-o6n / cubie-a7z / som-cm4):无变化,继续显示默认图。_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 风险,文件数与提交数合理)来源
_mainline-install.mdx中已有的rkdevtool_emmc_img可选参数用法。cc @hardware owner: 麻烦帮忙核对一下 Dragon Q8B 新的 UFS 模块硬件连接图是否准确,PR 合并前可以截图对比一下。