Skip to content

docs: redesign README (animated hero + product demo)#5275

Merged
waleedlatif1 merged 3 commits into
stagingfrom
readme-redesign-staging
Jun 30, 2026
Merged

docs: redesign README (animated hero + product demo)#5275
waleedlatif1 merged 3 commits into
stagingfrom
readme-redesign-staging

Conversation

@andresdjasso

Copy link
Copy Markdown
Contributor

@waleedlatif1 — README redesign, targeted at staging as discussed. Clean diff (just README.md + 3 image assets).

What

A visual redesign of the top-level README so it reads like the product:

  • Animated hero — one self-contained looping image: sim logo, the headline with the cycle-loader, a chat composer, and workflow + integrations peeking in.
  • One combined demo GIF — Integrate / Ingest / Build / Monitor header over an animated product tour: start a chat to build an agent → connect integrations → add a knowledge base → build the workflow visually → deploy → monitor runs in the logs.
  • All imagery is rendered from the real product UI (no mockups), full content width.

Notes

  • GitHub strips CSS positioning from READMEs, so the hero is baked into a single image rather than an HTML overlay — it renders identically everywhere.
  • Off-white (#F8F8F8) backgrounds; in dark mode these read as light cards (the single-asset trade-off — GIF can't be theme-aware without doubling assets).
  • Diff is README-only: the previous README's assets on staging are untouched.

🤖 Generated with Claude Code

A visual redesign of the top-level README:
- Self-contained animated hero (logo, headline with cycle-loader, chat composer,
  and workflow + integrations peeks) baked into one looping image.
- One combined demo GIF: Integrate / Ingest / Build / Monitor header over an
  animated product tour (chat → integrate → ingest → build → deploy → monitor).
- Graphics rendered from the real product UI, full content width.

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.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 30, 2026 2:40am

Request Review

@cursor

cursor Bot commented Jun 30, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
README and marketing asset references only; no application, API, or infrastructure code changes.

Overview
Redesigns the root README for a shorter, visual-first layout instead of the long feature walkthrough with separate GIFs and logo wordmark.

The top now uses updated neutral badge styling, a full-width readme-hero.gif hero, and a one-line product description. Multiple mid-page sections (chat, files, knowledge, tables, workflows) and their old static assets are removed in favor of a readme-tour.gif after the npx simstudio quickstart and a compact Capabilities bullet list.

Quickstart / self-hosting copy is tightened: cloud CTA badge simplified, NPM flags described inline instead of a table, and Docker Compose vs manual setup grouped under Self-hosting. The footer "Made with ❤️" text is replaced with readme-built-by-sim-team.png.

Reviewed by Cursor Bugbot for commit e104d84. 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 redesigns the top-level README with new product-focused visuals. The main changes are:

  • Updated badges and hero section.
  • Simplified quickstart and self-hosting copy.
  • Added a combined product tour GIF.
  • Added a visual footer image.

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
README.md Redesigns the README layout, messaging, badges, setup copy, and image references.
apps/sim/public/static/readme-hero.gif Adds the animated hero asset used by the README.
apps/sim/public/static/readme-tour.gif Adds the combined product tour asset used by the README.
apps/sim/public/static/readme-built-by-sim-team.png Adds the visual footer asset used by the README.

Reviews (1): Last reviewed commit: "docs(readme): redesign README — animated..." | Re-trigger Greptile

…artifacts

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

2 participants