docs: fix sponsor block markup and add header badges - #369
Open
SurefireStudios wants to merge 1 commit into
Open
SurefireStudios wants to merge 1 commit into
SurefireStudios wants to merge 1 commit into
Conversation
The sponsorship block had invalid HTML. Each entry opened an anchor inside a
heading but closed the heading first:
<h3><a href="...">coderabbit.ai - ...</h3>
<a href="...">
<img ...>
</a>
The first <a> is never closed, the </h3> lands inside it, and block-level
headings sit inside a <p>, which browsers implicitly close at the first <h3>.
Rendering depends on sanitiser recovery rather than the markup itself. Each
sponsor is now a closed anchor inside its heading, inside a <div> rather
than a <p>, with quoted width attributes and no trailing whitespace.
The Unblocked logo was also loaded from a third-party fork:
https://github.com/claire-gong-18/awesome-cursorrules/blob/main/...?raw=true
Unblocked-logo-sq-words-over-gradient-1024w.png is already committed here, so
the image now resolves locally. A sponsor logo should not depend on a fork
that this repository does not control.
Adds a badge row under the title for stars, forks, contributing and license.
The contributing badge links contributing.md, which the README did not
reference anywhere; check-awesome-list forbids Contributing in the Contents
section, and a badge stays outside that section.
Sponsorships stays as an HTML <h2> so Contents remains the first markdown
h2, as check-awesome-list requires. All 223 list entries are untouched.
Verified with scripts/check-awesome-list.mjs and
scripts/check-repo-hygiene.mjs --only readme, both passing.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe README adds GitHub repository badges and updates sponsorship markup with centered alignment, escaped ampersands, explicit image widths, and a local logo asset. ChangesREADME presentation updates
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This README-only change adds badges and repairs sponsor markup while preserving the list content; no concrete merge-blocking risk is identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
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
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.
+13 / -14, confined to the header. All 223 list entries are untouched — I verified by diffing the entry set and URL set before and after.I read
scripts/check-awesome-list.mjsandscripts/check-repo-hygiene.mjsfirst and kept the changes inside what they allow. Both pass locally, andawesome-lint@2.3.0reports no new findings.The sponsorship block is invalid HTML
Each entry opens an anchor inside a heading, then closes the heading first:
Three problems:
<a>is never closed. The</h3>lands inside an open anchor.<h3>elements sit inside a<p>, which the HTML parser implicitly closes at the first<h3>— so the centering wrapper stops applying partway through.width=350is unquoted.It renders acceptably today only because GitHub's sanitiser recovers from it. That recovery isn't a guarantee, and the same markup behaves differently outside GitHub (npm, mirrors, README aggregators).
Each sponsor is now a properly closed anchor inside its heading, wrapped in a
<div>instead of a<p>, with quoted attributes and the trailing whitespace after the Unblocked heading removed. Sponsor names, taglines, links and UTM parameters are byte-identical.The Unblocked logo loads from a fork
Unblocked-logo-sq-words-over-gradient-1024w.pngis already committed to this repository, but the README pulls it from a fork instead. If that fork is deleted, renamed, or made private, a paying sponsor's logo silently 404s. Now points at the local file, consistent with howcr_logo.pngis referenced.I left the Warp logo on
user-attachments— that's GitHub's own CDN, not a third-party repo.Badges
A row under the title for stars, forks, contributing and license.
The contributing badge links
contributing.md, which the README does not reference anywhere.check-awesome-list.mjsforbids a Contributing entry in the Contents section, and the README rightly has no License section — a badge satisfies discoverability without touching either rule.What I deliberately did not change
Reading the check scripts saved me from several changes that looked like improvements but are prohibited by design:
check-awesome-list.mjs:72explicitly forbids one.<h2>. Converting it to##would make it the first markdown h2 and break the "Contents must be the first top-level section" rule.checkContentsHierarchymatches the link exactly and would reject anything appended.checkRuleLinks, andscripts/convert-readme-links.mjsexists for it.Two things noticed, not addressed here
43 rule files in
rules/are not listed in the README — includingpython.mdc,react.mdc,go.mdc,rust.mdc,docker.mdc,fastapi.mdcandclean-code.mdc. Some look like deliberate short-slug duplicates of listed rules, so this needs curation judgement rather than a bulk edit. Happy to open a separate PR if you tell me which should be listed. (No broken links in the other direction — all 214 linked rules exist.)scripts/check-readme-hygiene.mjsandcheck-rule-hygiene.mjscrash on Windows. They build a path vianew URL(...).pathname, which yields/C:/...and resolves toC:\C:\...:fileURLToPath()would fix it. Doesn't affect CI on Linux, but it blocks Windows contributors from running the checks locally. Separate PR if wanted.Summary by CodeRabbit