Skip to content

README polish (2 libs) + cockpit OG image#294

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

README polish (2 libs) + cockpit OG image#294
blove merged 1 commit into
mainfrom
claude/readme-cockpit-og

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented May 13, 2026

Summary

Closes two loose ends from the post-merge sweep punchlist.

Library README polish

  • `libs/langgraph/README.md` — was 35 lines with only a title + one-liner + citations note. Now matches the `@ngaf/render` shape from D.1: intro paragraph, install + peer deps, capability bullets (`agent()`, `provideAgent()`, thread persistence, `MockAgentTransport`, `extractCitations()`), quick-start example with the Angular injection-context gotcha called out, citations example, doc links, license.
  • `libs/ag-ui/README.md` — was already substantive at 49 lines. Adds Install section, expands the one-liner to name the compatible runtimes (LangGraph / CrewAI / Mastra / Microsoft Agent Framework / AG2 / Pydantic AI / AWS Strands / CopilotKit), Part-of line, Documentation links footer, License.
  • `libs/licensing/README.md` — intentionally left alone. It explicitly says "Private, pre-1.0. Not intended as a standalone import."

Cockpit OG image

  • `apps/cockpit/src/app/opengraph-image.tsx` — new. 1200×630 PNG share card matching cockpit's Linear-style devtools aesthetic (Phase 8). Inter Bold headline rather than EB Garamond — saves bundling a 500KB TTF in the cockpit app and matches cockpit's in-app typography.
  • Footer renders the actual `ModeSwitcher` pill pattern (Run / Code / Docs / API with Run active) — visually echoes the real app.
  • `apps/cockpit/src/app/layout.tsx` — metadata expanded with proper `openGraph` + `twitter` blocks so the image is picked up on shares.

Test plan

  • `pnpm nx e2e cockpit` — 3 passed
  • `pnpm nx lint cockpit website` — 0 errors (21 pre-existing warnings)
  • Manual fetch of `/opengraph-image` from cockpit dev — renders the devtools card with active-Run mode pill
  • Verify on real share via LinkedIn / Twitter debugger after merge

🤖 Generated with Claude Code

…t OG image

Closes two loose ends from the post-merge sweep punchlist.

@ngaf/langgraph README:
- was: title + one-liner + only-citations section (35 lines, sparse for
  npmjs.com)
- now: matches @ngaf/render shape from D.1 — intro paragraph, install
  + peer deps, "What it does" capability bullets, quick-start example
  (provideAgent + agent()), injection-context gotcha callout, citations
  example, doc links, license.

@ngaf/ag-ui README:
- was already substantive (49 lines with usage + citations)
- adds Install section, expands one-liner to mention compatible runtimes
  (LangGraph / CrewAI / Mastra / etc.), Part-of line, Documentation
  links footer, License.

@ngaf/licensing README intentionally left alone — explicitly marked
"Private, pre-1.0. Not intended as a standalone import."

apps/cockpit/src/app/opengraph-image.tsx — new:
- 1200×630 PNG share card matching cockpit's Linear-style devtools
  aesthetic (Phase 8). Inter Bold headline (no Garamond — saves a
  500KB TTF bundle and matches cockpit's in-app typography).
- Eyebrow "COCKPIT · ANGULAR AGENT FRAMEWORK", headline "The live
  reference app for the framework.", subhead describing the four modes,
  footer renders the actual ModeSwitcher pill pattern (Run/Code/Docs/API
  with Run active) + cockpit.cacheplane.ai wordmark.
- runtime='edge' (no local font files to read).

apps/cockpit/src/app/layout.tsx — metadata expanded with proper
openGraph + twitter blocks so the new image gets picked up on shares.

All cockpit e2e tests pass; lint reports 0 errors (21 pre-existing
warnings).

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:10pm

Request Review

@blove blove merged commit 8918c7e 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