Skip to content

docs: fix malformed links and images - #4357

Open
orangeCatDeveloper wants to merge 1 commit into
apache:masterfrom
orangeCatDeveloper:docs/fix-broken-links
Open

docs: fix malformed links and images#4357
orangeCatDeveloper wants to merge 1 commit into
apache:masterfrom
orangeCatDeveloper:docs/fix-broken-links

Conversation

@orangeCatDeveloper

@orangeCatDeveloper orangeCatDeveloper commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Malformed Markdown in the HIP template and older blog posts leaves links unclickable, images rendered as text, and one configuration path with an unterminated code span.

Spaces between image markers and labels, nested link syntax, and a missing closing backtick prevent Markdown parsers from recognizing the intended elements.

Correct the affected links, image markers, and code span. The corrupted contributor-ladder sentence is reduced to its single intended link.

User-visible difference

Without this change, readers see an exclamation mark and linked alt text where the banner should appear; malformed external links either point to corrupted destinations or are not recognized as links; and the configuration path has a broken inline-code boundary.

With this change, the intended images render, the Mermaid and Apache contributor links open their real documentation pages, and only the configuration path is formatted as inline code.

Before

The banner is reduced to the visible text ! hertzBeat.

Before: the New Committer banner appears as an exclamation mark and text link

After

The New Committer banner renders as an image.

After: the New Committer banner renders correctly

@github-actions github-actions Bot added doc Improvements or additions to documentation HIP labels Sep 1, 2026
@orangeCatDeveloper
orangeCatDeveloper marked this pull request as draft September 1, 2026 05:29
@orangeCatDeveloper
orangeCatDeveloper marked this pull request as ready for review September 1, 2026 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation HIP

1 participant