Skip to content

docs(radxa-os): fix heading levels and note format in remote-access template - #1975

Merged
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/remote-access-heading-levels-20260807
Aug 7, 2026
Merged

docs(radxa-os): fix heading levels and note format in remote-access template#1975
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/remote-access-heading-levels-20260807

Conversation

@tangzz-radxa

@tangzz-radxa tangzz-radxa commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Optimize the remote-access template tutorials that back the Remote Access pages across products (rock3c, rock3a, cm3j, zero series, sbc template) plus the xfce basic software configuration page:

  1. Fix heading hierarchy: The imported MDX content previously started at ### (H3) directly under the H1 wrapper page, skipping H2. Promoted all content headings one level — ##### (SSH / VNC / TeamViewer), ####### (subsections), ######### (sub-subsections) — so the page renders a clean H1 → H2 → H3 → H4 hierarchy without skipped levels.
  2. Fix malformed admonition: The zh files had a broken note block ::注意 ... ::: (missing one colon). Changed to the standard :::note ... ::: convention, matching the en versions and other zh files in the repo.

Files changed (all zh + en pairs in sync):

  • docs/common/radxa-os/_remote-access.mdx + en counterpart
  • docs/common/radxa-os/xfce/_remote-access.mdx + en counterpart

Test plan

  • github_pr_guard.py pr 1975 passed: 4 files, bilingual pairs complete, no blocking reasons.

…emplate

- Promote imported content headings one level (H3->H2, H4->H3, H5->H4)
  so the section hierarchy matches the H1 wrapper without skipped levels
- Fix malformed admonition block (::注意 -> :::note) in the zh file,
  matching the en version and repo convention
…ess template

Same fixes as the shared template: promote content headings one level
(H3->H2, H4->H3, H5->H4) and fix the malformed ::注意 admonition to
:::note in the zh file. This variant backs the xfce basic software
configuration page.
@Milir-Radxa
Milir-Radxa merged commit 8025427 into radxa-docs:main Aug 7, 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