Skip to content

OG image + library README headers (Group D.1)#281

Merged
blove merged 1 commit into
mainfrom
claude/readme-og-pass
May 13, 2026
Merged

OG image + library README headers (Group D.1)#281
blove merged 1 commit into
mainfrom
claude/readme-og-pass

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented May 13, 2026

Summary

Group D.1 of the post-merge brand sweep. Two brand-facing improvements:

1. Dynamic OG / social-share card

`apps/website/src/app/opengraph-image.tsx` — Next.js `ImageResponse` at `/opengraph-image`. 1200×630 PNG, picked up automatically by every route via the Next.js metadata convention. Per-page overrides can be added later by dropping an `opengraph-image` file in any route folder.

Renders the marketing hero headline, subhead, trust pills (MIT / LangGraph + AG-UI / Angular 20+), and the cacheplane.ai wordmark on the same subtle blue gradient used by the homepage hero. Fetches Inter + JetBrains Mono from Google Fonts at request time.

Note: EB Garamond (the marketing-site h1 typeface) is NOT loaded — Satori does not decode woff2 and bundling TTF would add ~250KB to the repo. Headline falls back to Inter Bold, which reads cleanly and stays on-brand.

2. Library README headers

  • `libs/render/README.md` — was 3 lines of Nx scaffolding (`# render` + "This library was generated with Nx"). Now has a real intro paragraph, install command, capability bullets, and doc links. Public on npmjs.com as `@ngaf/render` when published.
  • `libs/chat/README.md` — title changed from `# chat` to `# @ngaf/chat — Drop-in Agent Chat for Angular`. The misleading "generated with Nx" boilerplate replaced with a one-line description pointing at the parent repo. Body content (runtime adapters, citations, A2UI theming) unchanged.

What's NOT in this PR

  • Root `README.md` — uses dark-mode-friendly `hero.svg` and `arch-diagram.svg` with `#6C8EFF` accent badges. The dark-on-dark aesthetic works as a coherent GitHub-dark-mode treatment; updating it isn't needed to match the marketing-site refactor.
  • 3 other library READMEs (`@ngaf/ag-ui`, `@ngaf/langgraph`, `@ngaf/licensing`) — each has a real intro paragraph already; left alone.
  • Error / 404 / loading pages — coming in D.2 (separate PR per the agreed split).

Test plan

  • `pnpm nx e2e website` — 35 passed
  • Manual check of the OG image at `/opengraph-image` — renders 1200×630 PNG with brand fonts + colors
  • Test the OG card on a real share (LinkedIn debugger / Twitter card validator) after merge

🤖 Generated with Claude Code

Adds two brand-facing improvements:

1. apps/website/src/app/opengraph-image.tsx — dynamic 1200×630
   PNG via Next.js ImageResponse, served at /opengraph-image. Picks
   up automatically for every route via Next.js metadata convention;
   per-route overrides can be added by dropping an opengraph-image
   file in any route folder. Fetches Inter + JetBrains Mono via
   Google Fonts at request time. Headline falls back to Inter Bold
   (Satori does not decode woff2, and bundling EB Garamond TTF would
   add ~250KB to the repo for marginal typography gain).

2. Library README headers:
   - libs/render/README.md — was 3 lines of Nx scaffolding. Now has
     a real intro, install command, capability summary, doc links.
   - libs/chat/README.md — title changed from "chat" to
     "@ngaf/chat — Drop-in agent chat UI for Angular 20+", and the
     misleading "generated with Nx" boilerplate replaced with a real
     one-line description. Body content unchanged.

Both READMEs are public on npmjs.com when their packages are published.

Root README + library badges + cacheplane.ai/assets/{hero,arch}.svg
intentionally untouched — they're dark-mode-friendly graphics that
work as a coherent GitHub-README aesthetic.

All 35 website e2e tests pass.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cacheplane Ready Ready Preview, Comment May 13, 2026 3:08am

Request Review

@blove blove merged commit 0fb31be into main May 13, 2026
14 checks 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