docs: mention RKDevelopTool-GUI as a no-compile alternative to rkdeveloptool#1908
Open
gahingwoo wants to merge 1 commit into
Open
docs: mention RKDevelopTool-GUI as a no-compile alternative to rkdeveloptool#1908gahingwoo wants to merge 1 commit into
gahingwoo wants to merge 1 commit into
Conversation
Adds a shared content page (docs/common/dev/_rkdeveloptool-gui.mdx, with an English mirror under i18n/en) describing RKDevelopTool-GUI, a third-party graphical front-end whose macOS/Linux release packages bundle a precompiled rkdeveloptool. Wires it up as a thin wrapper page next to the existing rkdeveloptool.md on the device families that use the V1 partial (Zero3, ROCK3A, ROCK3C, ROCK4C+, CM3, CM5, RockPi S0, template), and cross-links it from the existing rkdeveloptool install instructions. Disclosure: I'm the author of RKDevelopTool-GUI.
gahingwoo
requested review from
a team,
RadxaStephen and
vamrs-feng
as code owners
There was a problem hiding this comment.
Pull request overview
Adds documentation for RKDevelopTool-GUI (a third-party GUI front-end for rkdeveloptool) and exposes it across the device families that use the shared V1 rkdeveloptool partial, emphasizing that macOS (Apple Silicon) and Linux releases bundle a precompiled rkdeveloptool to avoid local compilation.
Changes:
- Adds new shared partial pages for RKDevelopTool-GUI in both ZH (
docs/common/...) and EN (i18n/en/...) trees. - Adds device/template wrapper pages that render the shared RKDevelopTool-GUI content next to existing
rkdeveloptoolpages. - Adds a cross-link tip to the existing shared
rkdeveloptoolpartials (ZH + EN) pointing readers to the new RKDevelopTool-GUI page.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/common/dev/_rkdeveloptool-gui.mdx | New shared ZH partial describing RKDevelopTool-GUI install/usage. |
| i18n/en/docusaurus-plugin-content-docs/current/common/dev/_rkdeveloptool-gui.mdx | New shared EN partial describing RKDevelopTool-GUI install/usage. |
| docs/common/dev/_rkdeveloptool.mdx | Adds ZH tip linking to the new RKDevelopTool-GUI page. |
| i18n/en/docusaurus-plugin-content-docs/current/common/dev/_rkdeveloptool.mdx | Adds EN tip linking to the new RKDevelopTool-GUI page. |
| docs/zero/zero3/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/zero/zero3/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/rock3/rock3a/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/rock3/rock3a/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/rock3/rock3c/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/rock3/rock3c/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/rock4/rock4c+/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4c+/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/rockpi/rockpis0/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/rockpi/rockpis0/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/som/cm/cm3/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/som/cm/cm3/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/som/cm/cm5/radxa-os/low-level-dev/rkdeveloptool-gui.md | New ZH wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/som/cm/cm5/radxa-os/low-level-dev/rkdeveloptool-gui.md | New EN wrapper page rendering the shared RKDevelopTool-GUI partial. |
| docs/template/module/radxa-os/low-level-dev/rkdeveloptool-gui.md | New ZH template wrapper page rendering the shared RKDevelopTool-GUI partial. |
| i18n/en/docusaurus-plugin-content-docs/current/template/module/radxa-os/low-level-dev/rkdeveloptool-gui.md | New EN template wrapper page rendering the shared RKDevelopTool-GUI partial. |
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
docs/common/dev/_rkdeveloptool-gui.mdx, with an English mirror underi18n/en/...) describing RKDevelopTool-GUI, a third-party graphical front-end for rkdeveloptool.doc_kind: wrapper/source_of_truth: commonconvention) next to the currentrkdeveloptool.mdon the device families that use the V1 partial: Zero3, ROCK3A, ROCK3C, ROCK4C+, CM3, CM5, RockPi S0, and the device template._rkdeveloptool.mdx(zh + en) pointing readers at the new page.Scope note: ROCK5-series and other devices using the V2/V3 rkdeveloptool partials aren't touched in this PR to keep the diff focused — happy to follow up there if this direction looks good.
Disclosure: I'm the author of RKDevelopTool-GUI, so this is a self-nomination of a third-party tool for inclusion in the docs. Feel free to push back on tone, placement, or scope.
Test plan
Tabs/TabItemblocks (macOS / Linux) on one of the wrapper pages, e.g. Zero3