chore(docs): evergreen README hero banner + install URL consistency - #1283
Merged
Merged
Conversation
…1282) The hero banner baked stale figures (v0.4.2, star count 16, 312 tests, wrong org slug codecora/uteke, wrong install URL) and is the image embedded in the launch tweet that new visitors see. - Add docs/assets/uteke-banner.svg as the source of truth. Evergreen by design: no version/star/test numbers (those live in the shields badges); install URL codecora.dev/uteke/install; ~45ms claim per the conservative-claim decision. - scripts/regen-banner.py renders the PNG at 2x via cairosvg; the generated PNG is committed because GitHub renders README images from the repo. - Fix docs/comparison.md install URL (codecora.dev/install -> codecora.dev/uteke/install). - Checklist note for AGENTS.md release rules is proposed in the PR body (agent-instruction file needs owner consent).
🔍 Cora AI Code Review✅ No issues found. Code looks good! Review powered by cora-code · BYOK · MIT |
… mascot Replaces the hand-drawn SVG mascot with the real product icon (docs/assets/uteke-icon.png, from uteke-mobile website/icon-512.png): the teal brainy-owl with the exposed brain and idea spark. cairosvg cannot embed raster images, so scripts/regen-banner.py now composites the icon into the avatar slot (rounded corners, PIL) after the SVG render; the SVG carries a comment pinning the avatar slot coordinates. Pillow >=10 resampling API.
Adopt the winning dev-banner pattern (Turso/Neon league): bottom teal glow, keyword highlighting in the headline, single teal accent across install command and meta rows. Footer links the mobile app (https://uteke.app) with a local-first privacy line. Still fully evergreen: no version/star/test numbers baked in.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
docs/assets/uteke-banner.svgas the source of truth for the README hero banner, regenerated touteke-banner.png@2x via newscripts/regen-banner.py(cairosvg). The banner is evergreen by design: no version / star / test counts baked in (dynamic figures live in the shields.io badges), install URL matches the README quick start (codecora.dev/uteke/install), and the latency claim is the conservative ~45ms.docs/comparison.mdinstall URL:codecora.dev/install→codecora.dev/uteke/install.Why
Closes #1282. The old banner baked stale figures — v0.4.2, ★16, 312 tests, org slug
codecora/uteke(current:codecoradev), and the wrong install URL — and it is the exact image embedded in the launch tweet by @dankornas (99K followers) that most new visitors see. A hand-edited PNG rots silently; an evergreen SVG + regen script removes the rot class.Note: a banner-regen checklist bullet for AGENTS.md release rules is proposed (owner-gated file, not edited here).
Testing
python3 scripts/regen-banner.py→ renders 2560×1280 PNG (202 KB) from the SVG; verified dimensions via PIL.codecora.dev/installreferences outside VitePress build artifacts (docs/.vitepress/dist, gitignored build output).