Skip to content

docs(readmes): strip groupId from badge labels — version was rendering too small#63

Merged
jlc488 merged 1 commit into
mainfrom
docs/strip-badge-labels
May 25, 2026
Merged

docs(readmes): strip groupId from badge labels — version was rendering too small#63
jlc488 merged 1 commit into
mainfrom
docs/strip-badge-labels

Conversation

@jlc488
Copy link
Copy Markdown
Contributor

@jlc488 jlc488 commented May 25, 2026

Summary

User feedback: every badge in the README tables had `?label=kr.devslab%3A`, which forced shields.io to fit the entire `kr.devslab:easy-paging-spring-boot-starter` text into the left half of the badge. That squeezed the version glyphs on the right side to the point where the actual version number was hard to read at normal page zoom.

Change

Stripped the `?label=...` parameter from all 19 badges in both `README.md` and `README.ko.md`. shields.io now uses its default `Maven Central` label, which is short enough that the version renders at a comfortable size.

Before:
```
Maven Central
```

After:
```
Maven Central
```

Why no information loss

  • Every row's first column already shows the demo name (e.g. `easy-paging-sb4-demo`), which uniquely identifies the library
  • The badge image is wrapped in a link to the Maven Central artifact page — one click and the coordinate is right there
  • The new compact label keeps the actual version (the thing users need to read) at a comfortable glyph size

Preserved

`versionPrefix=3` / `=4` filters on the easy-paging rows. Without them, the SB3 maintenance row's badge would jump to the latest `4.x` patch the moment one ships — defeating the whole point of the two-line layout. With the filter each line tracks its own latest.

Scope

  • `README.md`: 19 row edits (4 easy-paging SB4 + 4 easy-paging SB3 + 8 ssrf-guard + 3 api-log)
  • `README.ko.md`: same 19 rows

Same pattern as the profile README in devslab-kr/.github#9 — keeping the two surfaces visually consistent.

Test plan

  • CI green (docs only)
  • Render the README on GitHub and confirm: badge reads "Maven Central | 4.0.1" (etc.) at readable glyph size, click still lands on Maven Central page

…readability)

Per user feedback — when a badge's left side reads
'kr.devslab:easy-paging-spring-boot-starter' (the full coordinate),
shields.io has to fit a lot of pixels into the badge image, and the
version on the right ends up rendered too small to read at normal page
zoom. Dropping the label= parameter lets shields.io fall back to its
default 'Maven Central' tag, which is short enough that the version
glyphs render at a comfortable size.

Information loss is zero: every row's first column already shows the
demo name (which uniquely identifies the library), and the badge link
target is the artifact's Maven Central page. The coordinate is one
click away when a reader actually needs to copy it.

Applied across all 19 rows (4 easy-paging SB4 + 4 easy-paging SB3
maintenance + 8 ssrf-guard + 3 api-log). versionPrefix=3 / =4 filters
on the easy-paging rows are preserved — they keep the SB3 maintenance
line visually independent from the SB4 active line so the SB3 row
doesn't jump to the latest 4.x patch the moment one ships.

Same pattern as the profile README at devslab-kr/.github#9 — keeping
the two surfaces consistent.
@jlc488 jlc488 merged commit fb84e4d into main May 25, 2026
3 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.

1 participant