Skip to content

docs(x4): fix EN RP2040 example page heading structure (issue #528) - #2015

Merged
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/x4-c-sdk-examples-heading-528
Aug 18, 2026
Merged

docs(x4): fix EN RP2040 example page heading structure (issue #528)#2015
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/x4-c-sdk-examples-heading-528

Conversation

@tangzz-radxa

Copy link
Copy Markdown
Contributor

Fixes #528

Problem

The English version of the X4 RP2040 C SDK examples page
(i18n/en/.../x/x4/software/c_sdk_examples.md) had a broken heading
structure introduced in Dec 2024 (commit 73793f6):

  • An orphaned, empty ## OverView heading (no content under it)
  • A mismatched ## Relation introduction between J4215 and 40-PIN GPIO
    heading that does not exist in the Chinese version

The Chinese page only has ## 概述 followed by the relation content.
This made the rendered English page show an empty section and an
inconsistent heading hierarchy.

Fix

Merge both headings into a single ## Overview, matching the Chinese
## 概述 structure:

-## OverView
-
-## Relation introduction between J4215 and 40-PIN GPIO
+## Overview
 
 <RELATION />

The Chinese counterpart docs/x/x4/software/c_sdk_examples.md already
uses the correct ## 概述 structure, so no Chinese change is required —
this PR aligns the English page with it.

Scope

Tang ZZ and others added 2 commits August 15, 2026 16:25
The EN version of c_sdk_examples had an orphaned empty '## OverView'
heading plus a mismatched '## Relation introduction between J4215 and
40-PIN GPIO' heading, while the ZH page only has '## 概述'. This made
the rendered page show an empty section and inconsistent heading
hierarchy (reported in issue radxa-docs#528).

Merge both into a single '## Overview' heading to match the ZH
structure.
@Milir-Radxa
Milir-Radxa merged commit b8bfa82 into radxa-docs:main Aug 18, 2026
3 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.

Issue from x/x4/software/c_sdk_examples

2 participants