Skip to content

docs(readme): add the open-source launch banner - #1103

Merged
mitodrummer merged 3 commits into
mainfrom
docs/951-readme-figma-art
Jul 31, 2026
Merged

docs(readme): add the open-source launch banner#1103
mitodrummer merged 3 commits into
mainfrom
docs/951-readme-figma-art

Conversation

@agent-137

@agent-137 agent-137 commented Jul 30, 2026

Copy link
Copy Markdown
Member

Adds one image from the "Minimal - Marketing" Figma file (Social Media page) to the README — the launch banner at the top of the page — and points the external docs links at https://minimal.dev/docs.

Closes #951

What landed

Placement Figma frame Asset Size
Top of README Github (node 6194:74) docs/public/readme-banner.webp 90 KB

Exported at 2x (2560x1280), encoded as WebP at quality 90. The asset lives in docs/public/, the directory the README already sources loadout-demo.gif from, referenced by relative path — nothing is externally hosted. Figma has no light variant, so the banner is a self-contained dark panel on both themes.

The banner replaces the 120px logo mark

The banner already contains the mark, the wordmark, and the repo URL, so keeping the standalone mark directly above <h1>Minimal</h1> would have shown the same logo twice. docs/public/minimal-mark-{dark,light}.svg are left in place — no longer referenced from the README, but they may be consumed by the docs site build, so this PR does not remove them.

Frame selection

The Figma "Github" group is six 1280x640 variants of the same launch banner. This PR ships 6194:74 ("MINIMAL: NOW OPEN SOURCE", full cube field, repo URL in the footer) because its text stays legible at README width. The alternates are 6194:34, 6202:34, 6205:58 (centered composition), 6205:87 ("WE ARE OPEN SOURCE"), and 6205:105 (wordmark plus GitHub glyphs) — swapping is a one-line change if a different one is preferred.

Note

Add marketing banner image to README

Replaces the previous dark/light theme logo <picture> element in README.md with a single 880px-wide banner image sourced from the new readme-banner.webp asset.

Changes since #1103 opened

  • Updated documentation URL pattern from docs.minimal.dev to minimal.dev/docs across all references in the README, including the top navigation link, documentation badge, and inline documentation reference [3cebc6f]

Macroscope summarized 4a6ef3f.

Summary by CodeRabbit

  • Documentation
    • Updated the README with a centered banner image.
    • Refreshed the banner artwork.
    • Updated documentation links to point to the current documentation site.

Add four 2x exports from the "Minimal - Marketing" Figma (Social Media
page) as WebP: the open-source launch banner at the top of the README, the
harness-examples art under Getting Started, and the public-packages art at
the end of Tech Stack.

The banner replaces the standalone 120px logo mark, which it already
contains alongside the wordmark and repo URL. Examples ships as a
dark/light pair through <picture>; the banner and packages art have no
light variant in Figma and stay dark on both themes.

Closes #951

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ro13QovB1ffFqFwazxgokh
@agent-137
agent-137 requested a review from a team as a code owner July 30, 2026 07:24
@agent-137
agent-137 requested a review from mitodrummer July 30, 2026 07:24
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README now displays a centered readme-banner.webp image. Documentation links now use minimal.dev/docs. The banner asset was replaced with new WebP data.

Changes

README visual refresh

Layer / File(s) Summary
Refresh README artwork and links
README.md, docs/public/readme-banner.webp
The README header uses the centered banner image. Documentation links use minimal.dev/docs. The WebP banner asset contains updated image data.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: mitodrummer, twitchyliquid64

Poem

A rabbit hops beneath the sign,
The banner glows in WebP shine.
New links point the way ahead,
Documentation paths are neatly led.
A tidy README rests.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR implements the hero banner requirements in issue #951, but it does not implement the issue's requested section artwork. Add the remaining section artwork or remove the claim that this PR closes issue #951 and track the remaining work separately.
Out of Scope Changes check ⚠️ Warning The README documentation URL changes are unrelated to the linked issue's marketing artwork requirements. Move the documentation URL updates to a separate PR or add an explicit linked objective for them.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly and concisely describes adding the open-source launch banner to the README.
Description check ✅ Passed The description clearly explains the banner, asset details, documentation link updates, rationale, and related issue.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/951-readme-figma-art

Comment @coderabbitai help to get the list of available commands.

@agent-137
agent-137 marked this pull request as draft July 30, 2026 07:32
Per review: readme-banner.webp is the only image the README should add.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ro13QovB1ffFqFwazxgokh
@mitodrummer
mitodrummer marked this pull request as ready for review July 31, 2026 18:26
@agent-137 agent-137 changed the title docs(readme): decorate with the marketing Github-canvas art docs(readme): add the open-source launch banner Jul 31, 2026
@mitodrummer
mitodrummer merged commit c69c94d into main Jul 31, 2026
30 checks passed
@mitodrummer
mitodrummer deleted the docs/951-readme-figma-art branch July 31, 2026 19:03
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.

Decorate the minimal repo README with the marketing Figma Github-canvas art

4 participants