fix(template): stop top comment leaking + render the hero image#26
Conversation
Two rendering bugs visible in the raw template on GitHub:
- The header comment closed early. Line 8 read "Delete all HTML comments
(<!-- ... -->) before publishing" — the literal `-->` terminated the
opening `<!--` comment, so lines 8–17 (usage notes + the `-->`) rendered
as visible text. Reworded to "Delete all HTML comment blocks before
publishing" so the comment stays a comment.
- The hero `<img>` pointed at assets/logo.png, which doesn't exist, so it
rendered as a broken image. Default to the ResQ org banner via an absolute
raw URL (HTTP 200) so it renders in the raw template and in fresh repos;
consumers swap it for their own asset.
Remaining placeholder-driven artifacts (red "not found" badges, blank
Repobeats/contrib images) are expected for an unfilled template and resolve
once {{PLACEHOLDER}} values are filled in.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 25 minutes and 23 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ✨ 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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.template.md file by clarifying the instruction to delete HTML comment blocks and replacing the local placeholder logo with an absolute URL pointing to the ResQ organization banner. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
1 participant
Summary
Fixes two rendering bugs visible when
README.template.mdis viewed raw on GitHub (from the post-merge screenshots).1. Top comment leaked as visible text
Line 8 read
4. Delete all HTML comments (<!-- ... -->) before publishing. The literal-->closed the opening<!--comment early, so the usage notes (lines 8–17) and a stray-->rendered as body text at the top of the page. Reworded toDelete all HTML comment blocks before publishing— no nested terminator, comment stays hidden. Audited the rest of the file: the large automation comment (375–583) is intact; no other nested-->.2. Broken hero image
The hero
<img>pointed atassets/logo.png, which doesn't exist in the repo, so it rendered as a broken-image icon. Now defaults to the ResQ org banner via an absolute raw URL (verified HTTP 200) so it renders both in the raw template and in freshly-copied repos; consumers swap it for their ownassets/logo/banner.Not changed (expected behavior)
The red "not found" badges and blank Repobeats/contributor images in the screenshots are inherent to an unfilled template — they reference
{{NPM_PACKAGE}},{{REPO}},{{REPOBEATS_HASH}}, etc. They resolve once the template is copied and placeholders are filled. (Happy to add a visible "this is a template" notice or convert the example badges to a commented snippet if you'd rather the raw file render pristine — say the word.)Test plan
repo-standards/required-gategreen on this PR