Skip to content

docs(common/virtual-env): pass board prop to template, fallback to 'device'#1868

Merged
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/virtual-env-template-board-prop-20260623
Jun 23, 2026
Merged

docs(common/virtual-env): pass board prop to template, fallback to 'device'#1868
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/virtual-env-template-board-prop-20260623

Conversation

@tangzz-radxa

Copy link
Copy Markdown
Contributor

Summary

common/radxa-os/application-dev/virtual-env/ 下三个公共模板文件 (_conda_install.mdx_docker_use.mdx_conda_use.mdx) 的代码块 <NewCodeBlock tip=...> 从硬编码 radxa@device$ 切换为 tip={radxa@${props?.board ?? 'device'}$},与 ros-dev/ros2-dev/_install.mdxros-dev/ros1-dev/_install.mdx 已有的传参模式保持一致。

  • 已经在 wrapper 中传 board="<board-id>" 的产品 → 终端提示会渲染成 radxa@<board-id>$
  • 没有传 board 的 wrapper → 仍然回退到 radxa@device$,行为不变

中英文同步。

Files

  • docs/common/radxa-os/application-dev/virtual-env/_conda_install.mdx
  • docs/common/radxa-os/application-dev/virtual-env/_docker_use.mdx
  • docs/common/radxa-os/application-dev/virtual-env/_conda_use.mdx
  • i18n/en/.../virtual-env/_conda_install.mdx
  • i18n/en/.../virtual-env/_docker_use.mdx
  • i18n/en/.../virtual-env/_conda_use.mdx

Context

后续会有一个独立的 PR 给 Dragon Q8B 增加 Docker / Conda 虚拟环境教程,那批 wrapper 会传入 board="dragon-q8b";本次先把模板层的传参能力补齐。

不修改任何 wrapper 文件。

…evice'

Switch common virtual-env templates (_conda_install, _docker_use,
_conda_use) from hardcoded radxa@device$ to props?.board with
'device' fallback, matching the ROS2 install template pattern.

Wrappers that already pass board="..." will render the per-board
prompt; wrappers that do not pass board fall back to radxa@device$
with no behavior change. Mirror changes in i18n/en.
@Milir-Radxa Milir-Radxa merged commit 434da5e into radxa-docs:main Jun 23, 2026
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