Skip to content

docs: banner header + "What you get" feature list#57

Merged
jbrecht merged 1 commit into
mainfrom
readme-features-and-header
Jun 15, 2026
Merged

docs: banner header + "What you get" feature list#57
jbrecht merged 1 commit into
mainfrom
readme-features-and-header

Conversation

@jbrecht

@jbrecht jbrecht commented Jun 15, 2026

Copy link
Copy Markdown
Owner

Two README improvements for first-time visitors, from the empty-space-at-the-top observation.

Header

Replaces the small centered icon + redundant # tutorial-forge H1 with a slim 1280×400 banner header (icon + wordmark + tagline). It fills the dead horizontal space, drops the duplicate title, and its dark band reads as intentional on both GitHub light/dark themes (the icon's white tile looked orphaned in dark mode).

  • New docs/assets/readme-header.png (3.2:1, ~254KB), rendered from the logo via Playwright.
  • logo.png (square) is kept — it's the external app-logo URL (Vimeo) and isn't deleted.
  • social-banner.png (2:1) stays the asset for the GitHub social-preview upload.

"What you get"

Adds a scannable highlights section after the code example — capability breadth (chapters, intro/recap cards, localization, zoom, GIF export, idle speed-up, contact sheet, two recorders, doctor) was previously buried in a single run-on prose sentence. Four grouped one-liners, each linking to the relevant docs page. Curated, not exhaustive — the docs remain the catalog.

All five doc anchors validated against the current headings.

🤖 Generated with Claude Code

- Replace the standalone icon + redundant H1 with a slim 1280x400 banner
  header (icon + wordmark + tagline). Fills the dead horizontal space and
  reads well on both GitHub themes (the icon's white tile looked orphaned
  on dark mode). The square logo.png stays for external use (e.g. Vimeo);
  social-banner.png (2:1) remains the social-preview asset.
- Add a scannable "What you get" section (4 grouped highlights, linked to
  docs) so first-time visitors see the capability breadth that was
  previously buried in one prose sentence.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jbrecht jbrecht merged commit b1a3bd9 into main Jun 15, 2026
1 check passed
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