Skip to content

fix(readme): collapse vertical gaps in header#82

Merged
naorsabag merged 5 commits into
masterfrom
fix/readme-tight-header
May 7, 2026
Merged

fix(readme): collapse vertical gaps in header#82
naorsabag merged 5 commits into
masterfrom
fix/readme-tight-header

Conversation

@naorsabag
Copy link
Copy Markdown
Owner

@naorsabag naorsabag commented May 7, 2026

Summary

The merged #81 logo banner sits with visible vertical space above and below it because each part of the README header (`

`, the wrapping `

` for the image, and the `

` for the tagline) renders with default browser margins, and GitHub's markdown sanitizer strips inline `style="margin:0"` so we can't override them via CSS.

This PR removes the gaps structurally:

  • Drops the standalone `

    OpenHop

    ` (the GitHub repo page already shows the repo name as its own header).
  • Merges the logo `` and the tagline text into a single `

    `, separated by `
    `. Inside one paragraph, the image and text are inline content with zero margin between them.

Result: logo + tagline appear visually adjacent. Matches the logo-as-wordmark pattern used by Tailwind, Storybook, Remotion, and most modern dev-tool READMEs.

Linked context

Direct follow-up to #81 (the logo banner). No new audit items.

Testing notes

  • Single-file diff (`README.md`, +1 / -6).
  • Verified locally: rendered HTML has the image and tagline inside one `

    `, so the only outer margin is the parent paragraph's own — no inter-element gap.

  • No other markdown content moved; anchor nav, badges, "Works with" row, and `---` separator are unchanged.

Checklist

  • Build passes (`npm run build`)
  • Docs updated if user-facing behavior changed (README only)
  • CHANGELOG entry — header polish, will batch with v0.1.0 release notes

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Consolidated the top-of-doc branding into a single centered header combining the project title, logo, and two subtitle lines for improved visual alignment.
    • Confirmed all other README content (navigation, badges, sections, and body text) remains unchanged.

Drop the standalone <h1>OpenHop</h1> (the GitHub repo page header
already shows the repo name) and merge the logo image with the tagline
into a single <p align="center"> separated by <br/>. Putting the image
and text inline within one paragraph removes the default browser margin
that GitHub's markdown sanitizer doesn't let us override via inline
style.

Net result: zero visual gap above and below the logo. Matches the
logo-as-wordmark pattern used by Tailwind, Storybook, and Remotion.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

The README top header was consolidated into a single centered <h1 align="center"> that contains the project title, the docs/logo.png image, and two subtitle lines as <sub> elements; prior separate centered paragraphs for logo and subtitle were removed. No other files or exported APIs changed.

Changes

Top README Header Consolidation

Layer / File(s) Summary
Markup Consolidation
README.md
Replaced multiple centered elements (separate <h1> plus centered paragraphs) with one centered <h1 align="center"> containing title, logo image, and subtitles.
Subtitle Restructure
README.md
Moved the bold subtitle and secondary line into two <sub> lines inside the consolidated header.
Spacing / Separation
README.md
Preserved the blank line after the header to maintain separation before the rest of the README.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • naorsabag/openhop#81: Modifies README top branding/header to change rendering and centering of project title, logo, and subtitles.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix(readme): collapse vertical gaps in header' directly matches the main objective of the PR, which is to remove vertical spacing in the README header by restructuring elements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-tight-header

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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

naorsabag and others added 2 commits May 7, 2026 04:54
Restore the standalone title that the previous commit dropped. Keep the
image and tagline merged into one <p> so there's zero gap between them.
Remove the blank line between </h1> and <p> so markdown doesn't insert
extra paragraph spacing on top of the h1's default margin.

The title-to-image gap is the h1's default bottom margin from GitHub's
markdown CSS, which we can't override (inline style="margin:0" is
stripped by the sanitizer). This is the tightest we can get while
preserving the visible "OpenHop" title.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…o + tagline

Per request: the title, image, and tagline all share one <p align="center">
block now, so there is zero margin between every adjacent line.

Trade-off: the standalone <h1>OpenHop</h1> (which had its own default
margins) is replaced by <b>OpenHop</b> on its own line inside the <p>.
The text loses h1-size styling but the GitHub repo page header
(naorsabag/openhop at the very top) already plays the H1 role.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@naorsabag naorsabag force-pushed the fix/readme-tight-header branch from a6a1e49 to f173f15 Compare May 7, 2026 05:08
naorsabag and others added 2 commits May 7, 2026 08:10
Removed bold formatting from project name and description.
The previous commit introduced "# 🐇 OpenHop — …" as a markdown heading
directly above the <p align="center"> block with no blank line between.
Prettier's markdown rule (and CommonMark) requires a blank line between
adjacent block-level elements; CI's `npm run format:check` was failing
on this file.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@naorsabag naorsabag merged commit d06ed61 into master May 7, 2026
7 checks passed
naorsabag added a commit that referenced this pull request May 7, 2026
The post-#82 edits on master dropped the blank line between the
"# 🐇 OpenHop — …" heading and the <p align="center"> block. CI's
prettier format:check rejects adjacent block elements without a
blank line separator.

This is the same fix that landed in #82 (commit 0c0b1b0); replaying
it because master regressed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
naorsabag added a commit that referenced this pull request May 7, 2026
* fix(readme): crop logo to actual content (drop ~30% of vertical whitespace)

The current logo PNG is 1280x640 but the visible bunny + OPENHOP
wordmark only occupies 237 px of the height (~37%) — the rest is
transparent padding from the original ChatGPT source image. That
padding eats vertical space in the README header even though the
surrounding layout is already tight.

Threshold-cropped to alpha>32 + 16px padding: 1090x269. At
width=600 in the README the rendered height drops from ~300px to
~148px — visually closes the gap users have been reporting.

docs/logo.png and .github/social-preview.png are intentionally kept
distinct now: README image is content-tight; social preview keeps
the 1280x640 (2:1) framing GitHub's share-card UI expects.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(readme): add blank line after heading (prettier format check)

The post-#82 edits on master dropped the blank line between the
"# 🐇 OpenHop — …" heading and the <p align="center"> block. CI's
prettier format:check rejects adjacent block elements without a
blank line separator.

This is the same fix that landed in #82 (commit 0c0b1b0); replaying
it because master regressed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant