docs: rebuild the README around what a new user needs first - #293
Merged
Merged
Conversation
The first screen was a year-old "What's New in v2" notice, the eight inputs took a section each, and the job summary was reproduced four times, one per status, about 170 lines. - The header matches the org profile and the core README: the v4 banner (light and dark), the site's line, five badges in the brand colors and links to the docs, the CLI, the App and the MCP server. - The inputs are one table. - One failing job summary stays, as rendered; the passed, warned and skipped variants are a sentence each. - Runner requirements and the fork and Dependabot notes fold into <details>; the v2 breaking changes become a link to the v2.0.0 release notes. - The pre-commit link in the comparison table pointed at an anchor the core README never had; it now goes to the pre-commit guide. - The snippet under "Badging" was this repository's own CI status badge, so a user who pasted it advertised our build, not theirs. It is now the commit-check badge the core README and the site use. used-by.yml rewrites the "Used by" badge every week from its own inputs, so they change with it: color 2c9ccd, and the Ink label color carried in badge-logo, which the action appends to the query string as it is. Running used-by v0.1.5's badge generator against the new README reproduces the line byte for byte, so the job has nothing to change.
|
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 configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
Commit Check✅ All 5 checks passed Show all 5 checkscommit-check 2.18.1 · Rules reference |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #293 +/- ##
=======================================
Coverage 95.11% 95.11%
=======================================
Files 1 1
Lines 614 614
=======================================
Hits 584 584
Misses 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This was referenced Sep 27, 2026
shenxianpeng
added a commit
to commit-check/commit-check.com
that referenced
this pull request
Sep 27, 2026
This serves the Commit Check badge from the site, so the snippet a user copies becomes one line: ```markdown [](https://commit-check.com) ``` Today the snippet is a 519-character shields.io URL with the mark base64-encoded into it, and every page view makes a request to a third party. conventionalbranch.org/badge.svg already works this way. ## What's in it - **`docs/badge.svg`.** This is a hand-written copy of the shields.io render of the brand badge from [`branding/README.md`](https://github.com/commit-check/.github/blob/main/branding/README.md). It has the same 157×20 size, the same colors and flat style, and the same `textLength`, which keeps the text identical on machines without Verdana. The mark is drawn as vectors instead of an embedded image. A comment in the file explains all of this, including the contrast trade-off: white on Signal Blue is about 3:1, which is the color the badge has always had. MkDocs copies the file to the site root. - **Getting started.** A short *Show that you use it* section now shows the badge, with Markdown and reStructuredText snippets in tabs. Until now only the READMEs documented the badge. ## Checks - I rendered both files with `rsvg-convert` at 6× and compared them with ImageMagick. At 8% fuzz, 0 pixels differ, and the RMSE is 1.5e-5. - `mkdocs build --strict` passes (with `SOCIAL_CARDS=false`). `site/badge.svg` is in the output, and the page links it as `../badge.svg`. - `python -m pytest tests/ -q` passes with the released commit-check installed (10 tests). The pins and the changelog were already at 2.18.1, so nothing needed bringing into step. ## After this deploys Once `https://commit-check.com/badge.svg` is live, the long snippet elsewhere can switch to the short one: - the *Show that you use it* sections of the commit-check and commit-check-action READMEs (commit-check/commit-check#587, commit-check/commit-check-action#293); - the *README badge* section of `branding/README.md` in `.github`. The badge rows in those READMEs can stay on shields.io. Only the snippet users copy needs to change. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a “Show that you use it” section with a commit-check badge and copyable Markdown and reStructuredText snippets. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
](https://commit-check.com){kind=link}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is the Action half of the README pass started in commit-check/commit-check#587. The README goes from 558 to 306 lines, and much of what remains is folded away.
The old first screen was a year-old What's New in v2 notice. Each of the eight inputs had its own section, and the job summary was reproduced four times, once per status, which took about 170 lines.
What changed
editedtrigger forpr-titleas a tip under it.<details>blocks.commit-check#use-with-pre-commit, which never existed. It now goes to the pre-commit guide.Removed outright: the four-status transcripts, the raw
::errorannotation sample, the comment-marker internals, and the notes about which engine version first reportedskipandwarn. The action pins commit-check 2.18.1, so those version notes no longer apply to anyone using it.used-by.ymlThe weekly job rewrites the Used by line from its own inputs. Without a change there, the next run would put back
color=informational&logo=slickpic. The job now passesbadge-color: '2c9ccd'andbadge-logo: 'github&logoColor=white&labelColor=0b1620'. used-by appends both to the shields.io query string unchanged, which is how the Ink label color gets in.Checks
get_existing_badgeandgenerate_markdown_badgeagainst the new README produces the badge line byte for byte, so the job has nothing to change.Summary by CodeRabbit