docs(readme): tighten badge row for credibility (remove broken Downloads + Beta, green-ify 94-policies)#59
Merged
Merged
Conversation
User flagged that several badges were rendering in colours that read as warnings rather than credibility signals. Three fixes, applied consistently across all 5 READMEs (English + zh-CN + ja-JP + ko-KR + hi-IN): ## Downloads badge: removed (temporarily) The pepy.tech / shields.io PyPI-downloads endpoints both return red "not found" / "package not found" for the first 24-48 hours after a fresh PyPI release, because PyPI's download stats haven't propagated yet. A broken badge text is worse than no badge. Will re-add once stats start flowing (verify with \`curl https://img.shields.io/pepy/dt/aicertify.json\`). ## Beta badge: removed (redundant) The "status-beta" badge was orange and reads as a warning. The PyPI version badge directly next to it already shows v0.7.0 — readers infer "pre-1.0, expect some API churn" from semver alone. The CHANGELOG "Status" section still spells out what's production-ready vs partial, so no information loss. ## 94 Rego Policies badge: orange -> green The orange colour suggested caution; the content is unambiguously a positive signal ("we cover 94 policies across 15+ frameworks"). Switched the colour from \`orange\` to \`2f9e44\` (green) to match. ## Net effect 10 badges -> 8 badges, two of the three remaining warning-coloured badges removed, and the one credibility-positive number is now in green. The PyPI badge already renders correctly in blue (verified \`fill="#007ec6"\` in the SVG).
github-actions
Bot
added
📝 documentation
3 tasks
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.
You flagged that several badges were rendering colours that read as warnings rather than credibility signals. Three fixes, applied consistently to all 5 READMEs:
v0.7.0, so readers infer "pre-1.0" from semver. The CHANGELOG## Statussection still spells out what's production-ready vs partial.policies-94 regopolicies-94 rego(#2f9e44)Net effect
10 badges → 8. Cleaner row, no broken/warning colours. The PyPI badge (verified by SVG inspection —
fill="#007ec6"blue) and CI badge (last 5 main runs all green) already render correctly.Follow-up
Will queue a small PR to re-add the Downloads badge in ~48 h once pepy.tech has actual download data to show. The badge URL is preserved in the prior commit history for easy revert when ready.