Skip to content

docs: add README hero image#167

Merged
KeKs0r merged 1 commit into
mainfrom
docs/readme-hero
Jun 29, 2026
Merged

docs: add README hero image#167
KeKs0r merged 1 commit into
mainfrom
docs/readme-hero

Conversation

@KeKs0r

@KeKs0r KeKs0r commented Jun 29, 2026

Copy link
Copy Markdown
Member

What

Adds an on-brand hero image to the top of the README.

hero

Design

  • Uses chkit's own "Tungsten / V5" identity from the docs site: near-black canvas, peach accent (#fea16e), sharp corners, hairline borders, faint blueprint grid — rendered with the real Geist / Geist Mono / Goldman web fonts so it matches chkit.obsessiondb.com.
  • Split layout: ch-kit wordmark + headline + feature bullets on the left; a terminal showing the real generate → migrate → check flow on the right.
  • Language-neutral lead. TypeScript is no longer the hook — the payoff line is "as code." Language support is shown as small chips (TypeScript, Python soon), mirroring the docs hero's own badges, so Python users aren't filtered out.

Files

  • assets/hero.png — the image (1200×630 @2x, ~240 KB)
  • assets/hero.source.html — editable HTML source with repo-relative font paths, so the PNG can be regenerated
  • README.md — embeds the hero above the title

Regenerating

Edit assets/hero.source.html, then render it from the assets/ dir at 1200×630 (deviceScaleFactor 2) to hero.png via headless Chromium.

On-brand hero (chkit Tungsten identity) at the top of the README: split layout with the ch-kit wordmark, headline, feature bullets, and a terminal showing the generate -> migrate -> check flow. Language support (TypeScript, Python soon) shown as understated chips rather than the lead. Includes the editable HTML source (assets/hero.source.html) with repo-relative font paths so it can be regenerated.
@KeKs0r KeKs0r merged commit 143c35d into main Jun 29, 2026
6 checks passed
@KeKs0r KeKs0r deleted the docs/readme-hero branch June 29, 2026 07:43
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