Skip to content

docs: README redesign — banner + platform screenshot#5283

Open
andresdjasso wants to merge 4 commits into
stagingfrom
readme-design-v2
Open

docs: README redesign — banner + platform screenshot#5283
andresdjasso wants to merge 4 commits into
stagingfrom
readme-design-v2

Conversation

@andresdjasso

@andresdjasso andresdjasso commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #5275 (the initial README redesign already on staging). This reworks it into a shorter, cleaner layout — closer to the n8n README style.

Changes

  • New banner — a grey block with the four feature illustrations (Integrate · Context · Build · Monitor) and the sim logo on the right. Static, compact.
  • Platform screenshot — one real shot of the product two-pane: the chat conversation on the left, the workflow on the right (rendered straight from the live UI, not mocked).
  • Dropped the animated gifs (hero + tour) in favor of the two static images — lighter and more to the point.

Diff is README-only: adds readme-banner.png + readme-platform.png, removes the old readme-hero.gif + readme-tour.gif.

🤖 Generated with Claude Code

…shot

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
docs Skipped Skipped Jun 30, 2026 3:26pm

Request Review

…right) on off-white

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ne (one window)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@andresdjasso andresdjasso marked this pull request as ready for review June 30, 2026 15:31
@andresdjasso andresdjasso changed the title docs: README redesign v2 — static banner + platform screenshot (WIP) docs: README redesign — banner + platform screenshot Jun 30, 2026
@andresdjasso

Copy link
Copy Markdown
Contributor Author

@waleedlatif1 this is the README redesign follow-up to #5275 — shorter/cleaner layout, new banner + a real platform screenshot, gifs dropped. README-only diff against staging. Ready for your read-through + merge whenever 🙏

@cursor

cursor Bot commented Jun 30, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
README-only documentation and asset swaps with no impact on product code or infrastructure.

Overview
Updates the README visuals to a shorter, static layout: the top hero switches from readme-hero.gif to readme-banner.png (Integrate · Context · Build · Monitor + updated alt text), and the post–self-host quickstart image switches from readme-tour.gif to readme-platform.png (two-pane product screenshot).

No application code, config, or runtime behavior changes—only README image paths, alt text, and the associated static assets.

Reviewed by Cursor Bugbot for commit f24dc4c. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps

greptile-apps Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR refreshes the README visuals with static product images. The main changes are:

  • Replaces the hero GIF with readme-banner.png.
  • Replaces the tour GIF with readme-platform.png.
  • Removes the old animated README GIF assets.

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
README.md Updates the README image references to the new static PNG assets.
apps/sim/public/static/readme-banner.png Adds the new static README banner image.
apps/sim/public/static/readme-platform.png Adds the new static README platform screenshot.
apps/sim/public/static/readme-hero.gif Removes the old animated README hero image.
apps/sim/public/static/readme-tour.gif Removes the old animated README tour image.

Reviews (1): Last reviewed commit: "docs(readme): platform shot — capture th..." | Re-trigger Greptile

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