Skip to content

docs: document the hosted badge in the branding guide - #63

Merged
shenxianpeng merged 1 commit into
mainfrom
docs/short-badge-snippet
Sep 27, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
docs/short-badge-snippet

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

commit-check.com has served the badge at /badge.svg since commit-check/commit-check.com#46, and the READMEs now give users that one line (commit-check/commit-check and commit-check/commit-check-action, docs/short-badge-snippet).

In the branding guide, the README badge section now:

  • starts with the hosted badge and its snippet;
  • points to docs/badge.svg in commit-check.com and says what it is: a hand copy of the shields.io render, with badge-logo.svg drawn as vectors;
  • keeps the full shields.io URL, because it is where the geometry comes from and it is the one to use for a different style=;
  • explains how to carry a change over: re-render on shields.io, then copy the widths, text x and textLength into docs/badge.svg.

The paragraph on why the shields.io URL is long is unchanged.

Summary by CodeRabbit

  • Documentation
    • Updated badge guidance with a copyable Markdown snippet, an alternate Shields.io URL, and instructions for refreshing the hosted badge image.

commit-check.com serves the badge at /badge.svg since
commit-check/commit-check.com#46, and the READMEs now hand users that
one line. The branding guide leads with it, keeps the shields.io URL as
the source of the badge's geometry and the way to get another style=,
and says how to carry a change from one to the other.
@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: a850c537-d4a2-41da-bb06-6b12d2b5d42a

📥 Commits

Reviewing files that changed from the base of the PR and between 13f5461 and 9691c63.

📒 Files selected for processing (1)
  • branding/README.md
 ____________________________________________
< This is what it sounds like when bugs cry. >
 --------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

Commit Check

✅ All 3 checks passed

Show all 3 checks
Commit message
  ✔ PR title (docs: document the hosted badge in the branding guide)
  ✔ Commit 1/1 (9691c63) (docs: document the hosted badge in the branding guide)
Branch
  ✔ Branch (docs/short-badge-snippet)

commit-check 2.17.0 · Rules reference

@shenxianpeng
shenxianpeng merged commit 3ccf55e into main Sep 27, 2026
2 of 3 checks passed
@shenxianpeng
shenxianpeng deleted the docs/short-badge-snippet branch September 27, 2026 17:01
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant