docs: add social-sharing banner to README#238
Conversation
) Add a hand-authored 1280x640 SVG banner (with a rendered PNG for social cards) at the top of the README, above the badges. Uses the existing brand indigo palette (#3949ab / #5c6bc0) on a dark navy-indigo background, the repo logo motif, the tagline "pytest-level simplicity for AI evaluation", and a terminal card showing real `oaeval run` output with green metric scores. - docs/assets/banner.svg — primary artifact, crisp on GitHub, all text as <text> (no external fonts/images), explicit width/height + viewBox - docs/assets/banner.png — 1280x640 export for Open Graph / social cards - README.md — centered banner + alt text above the title/badges Closes OpenAgentHQ#236 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
@Nitjsefnie Update the Readme.md as open-source community focused . banner is good , if you could make it in black background like terminal that would be great |
Recolor the social banner to a true near-black, terminal-like palette (same composition and text) per maintainer feedback, and rework the README to foreground the open-source community: a top-third Contributing & Community section with ways to help, good-first-issue / help-wanted links, get-started steps, and existing community links. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Both done in 1a99932: the banner background is now true terminal-black (composition untouched — glows dimmed, the card panel lightened a step with a subtle border so it still reads as a card, lavender text bumped for contrast), and the README got the community pass — a "Contributing & Community" section in the top third (ways to help with live good-first-issue/help-wanted label links, 4-step getting-started pointing at CONTRIBUTING.md, and Discussions/Issues/docs links — every link verified to exist, nothing invented), consolidating the old bottom Contributing/Community sections; install/quickstart/features content untouched. |
|
@Nitjsefnie just update the logo with the organization offlical logo then ready to merge |
Replace the drawn indigo list-mark with the organization's official logo (the OpenAgentHQ avatar) embedded as a self-contained base64 PNG data URI, clipped to the same rounded 96x96 box. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Done in c518a4f — the banner now carries the official OpenAgentHQ mark (the org avatar; note the in-repo docs/assets/logo.svg is a different design, so I used the avatar), embedded as a self-contained data URI in the same rounded-square spot. On the black background it reads as the white mark on a subtle darker tile — if you'd rather have it on a colored tile like the old indigo box, that's a one-line recolor, say the word. |
|
🎉 Congratulations @Nitjsefnie! Your pull request has been successfully merged into main. 🚀 Thank you for contributing to OpenAgentHQ and helping improve the project. We truly appreciate your contribution and hope to see you back with more amazing PRs! Happy Open Sourcing! ❤️ |
2 participants
Fixes #236
Adds
docs/assets/banner.svg(6.5 KB, hand-authored — all text as<text>, no external resources, GitHub-renderable) plusdocs/assets/banner.png(1280×640, 146 KB) for Open Graph/social-card use, embedded at the top of the README inside the existing centered div per the issue's example placement, with alt text.Design: the repo's own Material-Indigo brand (pulled from logo.svg/favicon.svg) on a dark navy-indigo gradient; left side carries the logo mark, wordmark, the "pytest-level simplicity for AI evaluation" tagline, a feature line, and three score bars; right side is a terminal card showing
oaeval run config.yamlwith four real metric names and green pass-scores. Restrained and geometric — no stock AI clip-art.One note on the path: the issue's title says
static/openagent-eval.pngbut its own example placement references./docs/assets/banner.png, and the repo's existing brand assets (hero/logo/favicon) live indocs/assets/— so the assets follow the example and the convention. Trivial to move if you preferstatic/.Layout is drift-proofed for the renderer differences (explicit column coordinates +
text-anchor, no space-padding; wordmark sized to clear the card in the widest fallback font).Generated by Claude Fable 5 (brief, review), Claude Opus 4.8 (implementation)