Skip to content

docs: align the DeepWiki badge with the badge row - #4056

Merged
M4n5ter merged 1 commit into
apache:mainfrom
Astro-Han:docs/readme-deepwiki-badge-align
Aug 28, 2026
Merged

docs: align the DeepWiki badge with the badge row#4056
M4n5ter merged 1 commit into
apache:mainfrom
Astro-Han:docs/readme-deepwiki-badge-align

Conversation

@Astro-Han

@Astro-Han Astro-Han commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

The third-party AI documentation label sits below the DeepWiki badge's bottom edge instead of on its centre line. An <img> aligns to the text baseline, so the badge's bottom edge rests on it, and <sub> then drops the following text a further 0.25em. GitHub strips inline styles from READMEs, so this cannot be corrected with CSS.

Fold the disclosure into the badge text itself and move the badge into the existing badge row. With no separate text node there is nothing left to misalign, the badge shares the row's 20px height and the #9BB8F0 tone already used for the Windows preview badge, and the extra centred <p> disappears — six lines removed, two added, across both READMEs.

The trade is DeepWiki's own badge artwork. The disclosure has to stay visible, and keeping their badge means keeping a second element beside it; carrying the label inside one badge is what removes the failure mode rather than re-styling it.

Refs #4035, refs #4052

Verification

Rendered both READMEs through GitHub's own Markdown API (gh api /markdown --mode gfm) and compared before/after in light and dark themes at 2.3x. Badge SVGs confirmed at 20px, matching the rest of the row.

README.md:

image

README.zh-CN.md:

No test suites run: the change is Markdown only and Biome does not cover it.

AI use

  • No generative tool made a substantive contribution
  • Generative tooling made a substantive contribution

Tool(s) and scope: Claude Code diagnosed the baseline cause, authored the README edits and the commit message, and produced the rendered comparison. The human contributor reviewed the diff and the rendered result.

Checklist

  • Tests cover the change and fail without it
  • Lint, format, typecheck and the affected suites pass locally

Does this PR entail a change in behavior?

  • Yes — described under Summary above
  • No

The disclosure rendered below the badge's bottom edge: an <img> aligns to
the text baseline, and <sub> drops the following text a further 0.25em, so
the caption hung off the badge. GitHub strips inline styles, so no CSS fix
is available in a README.

Fold the disclosure into the badge itself and move it into the existing
badge row. The separate <p> and the <sub> caption both go away, the badge
matches the row's height and palette, and the misalignment cannot recur.

Generated-by: Claude Code
@github-actions github-actions Bot added the effort/XS Under 10 readable lines label Aug 28, 2026
@Astro-Han
Astro-Han marked this pull request as ready for review August 28, 2026 04:57
@Astro-Han
Astro-Han requested a review from M4n5ter August 28, 2026 05:40
@M4n5ter
M4n5ter merged commit fd31c92 into apache:main Aug 28, 2026
3 checks passed
@Astro-Han
Astro-Han deleted the docs/readme-deepwiki-badge-align branch August 28, 2026 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/XS Under 10 readable lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants