Skip to content

docs: switch rk2501 family products to VSCode + make deb build flow#1941

Merged
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/kernel-rk2501-build-system-20260722
Jul 22, 2026
Merged

docs: switch rk2501 family products to VSCode + make deb build flow#1941
Milir-Radxa merged 1 commit into
radxa-docs:mainfrom
tangzz-radxa:docs/kernel-rk2501-build-system-20260722

Conversation

@tangzz-radxa

Copy link
Copy Markdown
Contributor

Summary

Switch affected product docs in the radxa-pkg/linux-rk2501 family from the old bsp-based kernel build flow to the new VSCode Dev Container + make deb flow, mirroring q6a / q8b / cubie / orion / fogwise.

Source of truth

Kernel meta-package mapping taken from debian/control of https://github.com/radxa-pkg/linux-rk2501:

Package slug Docs path
linux-image-rock-pi-s rockpi/rockpis
linux-image-rock-pi-4a / 4a-plus / 4b / 4b-plus / 4c rock4/rock4ab-se (covers 5 products in one docs site)
linux-image-rock-4se rock4/rock4ab-se
linux-image-rock-4c-plus rock4/rock4c+ (previously had inline bsp prose, not a wrapper)

Changes

For each affected product:

  • delete docs/<product>/low-level-dev/kernel.md (old bsp wrapper or inline prose)
  • add docs/<product>/low-level-dev/build-system/install-env.md (shared env wrapper)
  • add docs/<product>/low-level-dev/build-system/kernel.md (new wrapper, git_url="https://github.com/radxa-pkg/linux-rk2501")

Same set of changes mirrored under i18n/en/docusaurus-plugin-content-docs/current/....

Notes

  • Old common/dev/_kernel.mdx and common/dev/_install_env.mdx are kept untouched.
  • PR guard warns about scope count (3); intentional given the cross-product nature of this task.
  • Bilingual check passes.
  • rock4/rock4c+ had a non-wrapper kernel.md with direct bsp commands; it is removed and replaced with the new wrapper.

Cover products shipping a kernel meta-package from
https://github.com/radxa-pkg/linux-rk2501:
  - ROCK Pi S
  - ROCK 4A / 4A+ / 4B / 4B+ / 4C  (single docs site: rock4/rock4ab-se)
  - ROCK 4C+  (rock4/rock4c+ had inline bsp commands; replaced)
  - ROCK 4SE  (covered by rock4/rock4ab-se)

Replaces the old bsp-based kernel.md under low-level-dev/ with the new
VSCode Dev Container + 'make deb' wrapper under
low-level-dev/build-system/, mirroring q6a / q8b / cubie / orion /
fogwise. Environment setup wrapper (install-env.md) is shared via the
common mdx.

For rock4/rock4c+ the previous kernel.md was direct bsp prose (no
wrapper); it is removed and replaced with the new wrapper.

Same change mirrored under
i18n/en/docusaurus-plugin-content-docs/current/...
@tangzz-radxa
tangzz-radxa force-pushed the docs/kernel-rk2501-build-system-20260722 branch from 63c9bd6 to 859ff9a Compare July 22, 2026 10:46
@Milir-Radxa
Milir-Radxa merged commit 135b463 into radxa-docs:main Jul 22, 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