docs: fix broken relative links introduced in #1908#1918
Merged
Milir-Radxa merged 1 commit intoJul 8, 2026
Conversation
_rkdeveloptool-gui.mdx and _rkdeveloptool.mdx live in docs/common/dev/, but they linked to ./rkdeveloptool.md, ./rkdevtool.md and ./rkdeveloptool-gui.md as if those wrapper pages were siblings. They aren't (each device's wrapper page lives under its own low-level-dev/ directory), so the build reported 'Docs markdown link couldn't be resolved' warnings for both locales. Drop the links in favor of plain text, matching how _rkdevtool.mdx/_rkdeveloptool.mdx already cross-reference each other elsewhere in this file.
There was a problem hiding this comment.
Pull request overview
This PR follows up on #1908 by removing broken sibling-relative links from shared MDX partials under docs/common/dev/ (and their English mirrors). Because these partials are imported into device-specific wrapper pages under each device’s low-level-dev/ directory, links like ./rkdeveloptool-gui.md were never resolvable from the partial’s filesystem location, producing Docusaurus unresolved-link warnings during deploy builds.
Changes:
- Remove unresolved relative links in the shared
rkdeveloptoolpartials (zh + en) that pointed to non-sibling wrapper pages. - Remove unresolved relative links in the shared
rkdeveloptool-guipartials (zh + en) that pointed to non-siblingrkdeveloptool/rkdevtoolwrapper pages. - Preserve the intended cross-reference wording by switching those references to plain text (matching the pattern already used elsewhere in these partials).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| i18n/en/docusaurus-plugin-content-docs/current/common/dev/_rkdeveloptool.mdx | Removes a broken relative link to rkdeveloptool-gui.md inside a shared tip block. |
| i18n/en/docusaurus-plugin-content-docs/current/common/dev/_rkdeveloptool-gui.mdx | Removes broken relative links to rkdeveloptool.md / rkdevtool.md from the shared GUI partial. |
| docs/common/dev/_rkdeveloptool.mdx | Removes a broken relative link to rkdeveloptool-gui.md inside a shared tip block (Chinese). |
| docs/common/dev/_rkdeveloptool-gui.mdx | Removes broken relative links to rkdeveloptool.md / rkdevtool.md from the shared GUI partial (Chinese). |
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
Follow-up to #1908. The Deploy build (correctly) logged warnings for that PR:
_rkdeveloptool-gui.mdxand_rkdeveloptool.mdxlive indocs/common/dev/, but linked to./rkdeveloptool.md,./rkdevtool.md, and./rkdeveloptool-gui.mdas if those were siblings. They aren't — each device's wrapper page lives under its ownlow-level-dev/directory, not next to the shared partial, so the relative links never resolve. This drops the links in favor of plain text, matching how_rkdevtool.mdxand_rkdeveloptool.mdxalready cross-reference each other elsewhere in this file (plain "This article is not about ..." text, no link).Note: these were warnings, not build failures — the
buildjob failures seen onmainaround this time (including on #1908's own post-merge run) look like an unrelated CI issue: other, unrelated merges from the same window show the identicalThe runner has received a shutdown signal/The operation was canceledfailure, which looks like the Deploy job getting cancelled by a subsequent push before the ~10+ minute build finishes, not a content error.Test plan