Skip to content

docs: redesign README (platform banner + product tour)#5271

Closed
andresdjasso wants to merge 5 commits into
mainfrom
codex/readme-redesign
Closed

docs: redesign README (platform banner + product tour)#5271
andresdjasso wants to merge 5 commits into
mainfrom
codex/readme-redesign

Conversation

@andresdjasso

@andresdjasso andresdjasso commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What

A visual redesign of the top-level README.md so the GitHub landing reads like the product.

  • Hero — sim logotype + a headline with the animated cycle-loader inline.
  • Platform banner — a light-mode peek at the real product UI (the workflow builder on the left, integrations top-right).
  • Feature row — Integrate / Ingest / Build / Monitor.
  • Product tour GIF — one continuous take of a user navigating the real app: start a chat to build an agent, connect integrations, add a knowledge base, build the workflow visually, deploy it, then monitor runs in the logs.
  • Refreshed Quickstart / Capabilities copy aligned with our positioning ("the open-source AI workspace where teams build, deploy, and manage AI agents").

Notes for reviewers

  • All imagery is built from screenshots/recordings of the real Sim UI (no mockups).
  • Banner caveat: in the design preview the banner has a centered logo + headline + chat surface overlaid on it. GitHub strips HTML/CSS positioning from README markdown, so on GitHub the banner shows the UI graphic with the hero text above it and an open center. If we want GitHub to match the preview exactly, the fix is to bake the full composition into a single banner image — happy to do that as a follow-up.
  • Only README.md + its 7 referenced assets are in this PR. The capture tooling/routes used to generate the imagery are intentionally left out.

🤖 Generated with Claude Code

@andresdjasso @claude
docs(readme): redesign README with platform banner and product tour
bebd785 
- Hero logotype + animated cycle-loader headline
- Platform UI banner (workflow builder + integrations peeking)
- Integrate / Ingest / Build / Monitor feature row
- Continuous product-tour GIF: chat → integrate → ingest → build → deploy → monitor
- Refreshed Quickstart / Capabilities copy aligned with positioning

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

vercel Bot commented Jun 29, 2026 •
edited
Loading

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 1:08am

Request Review

@cursor

cursor Bot commented Jun 29, 2026 •
edited
Loading

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and marketing assets only; no application, API, or infrastructure code changes.

Overview
Redesigns the GitHub README so the repo landing page matches current product positioning instead of the older multi-section demo layout.

The top of the page now leads with refreshed link badges, a single full-width readme-hero.gif, and a short one-line value prop. The previous wordmark block and separate feature GIFs (chat, files, knowledge, tables, workflows) are removed in favor of that tighter hero.

Quickstart and self-host copy is reorganized: cloud vs self-hosted is clearer, NPM npx simstudio notes are inlined (Docker, --port, --no-pull), and a readme-tour.gif walks through Integrate → Ingest → Build → Monitor after the NPM section. A new Capabilities bullet list replaces scattered feature headings.

Self-hosting section headings are simplified (Docker Compose / Manual Setup under one parent). The footer swaps “Made with ❤️” text for readme-built-by-sim-team.png.

New static assets include readme-logotype-dark.svg and a large readme-feature-row.svg (Integrate / Ingest / Build / Monitor illustrations); the README diff references the hero, tour, and team footer images directly.

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

@greptile-apps

greptile-apps Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR redesigns the repository README with a more product-focused landing page. The main changes are:

  • New centered badge rows and refreshed hero copy.
  • New README logotype, banner, feature row, tour, loader, and footer assets.
  • Reworked quickstart, capabilities, and self-hosting sections.

Confidence Score: 5/5

This looks safe to merge after a small README warning for the CLI quickstart.

  • The asset references added by the README point to files included in the PR.
  • The external badge and product links are valid from the changed markdown.
  • The only follow-up is documenting the security posture of the CLI self-hosting path.

README.md

Security Review

The README now promotes the CLI self-hosting path without warning that it starts with placeholder secrets, which can lead to insecure self-hosted deployments.

Important Files Changed

Filename Overview
README.md Redesigned landing content and self-hosting docs; the CLI quickstart should warn about placeholder deployment secrets.
apps/sim/public/logo/readme-logotype-dark.svg New dark-fill README logotype asset.
apps/sim/public/logo/readme-logotype-light.svg New light-fill README logotype asset.
apps/sim/public/static/readme-built-by-sim-team.png New README footer image asset.
apps/sim/public/static/readme-cycle-loader.gif New inline README loader GIF asset.
apps/sim/public/static/readme-feature-row.svg New README feature row illustration.
apps/sim/public/static/readme-platform-banner.png New README platform banner image.
apps/sim/public/static/readme-tour.gif New README product tour GIF.

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

greptile-apps[bot]
greptile-apps Bot reviewed Jun 29, 2026
View reviewed changes
Comment thread README.md
### Ground agents in your knowledge
Upload documents to a knowledge base and let agents answer questions from your own content.
```bash
npx simstudio

@greptile-apps greptile-apps Bot Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 security CLI Quickstart Uses Default Secrets

When a user follows the new primary self-hosted quickstart, npx simstudio starts the CLI-managed Docker deployment with the package's built-in placeholder auth and encryption secrets. The Docker Compose path asks operators to provide these values, but the quickstart now promotes the CLI path without warning, so users can end up with a running self-hosted instance using predictable credentials.

@andresdjasso @claude
docs(readme): re-bake banner, tour, and loader on white
5057bca 
GitHub renders the README on white in light mode, so the baked #F8F8F8
backgrounds showed as grey boxes. Regenerate the platform banner, the
product-tour GIF margin, and the cycle-loader on pure #FFFFFF so the
imagery is seamless in light mode (clean light cards in dark mode).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@andresdjasso @claude
docs(readme): bake hero into one self-contained animated image
af59160 
GitHub strips the CSS overlay used in the standalone preview, so the logo +
headline + chat couldn't sit on the banner. Bake the whole hero (logo,
headline, animating loader, chat composer, workflow + integrations peeks)
into a single looping GIF on the off-white (#F8F8F8) background, so GitHub
renders it exactly like the preview. Give the feature row and tour the same
off-white background so all three read as a consistent set.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@andresdjasso @claude
docs(readme): merge feature row into the demo gif; full-width graphics
114ad08 
- Bake the Integrate / Ingest / Build / Monitor feature row as a static header
  band on top of the animating product tour, so it's one self-contained GIF
  (off-white, infinite loop) instead of two separate assets.
- Set the hero, demo, and footer to width="100%" so the graphics span the full
  content width, flush with the surrounding text and code blocks.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@andresdjasso @claude
fix(readme): restore white workflow blocks in hero; soften mosaic shadow
c2aa945 
The off-white background pin used too wide a fuzz and merged the white block
fills (#FFFFFF) into the off-white (#F8F8F8) — only 7 levels apart. Re-encode
the hero with ffmpeg's frequency palette (stats_mode=full) + dither=none so the
background and the white surfaces stay distinct, and soften the integrations
card shadow so it bands less under GIF's 256-color limit.

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

andresdjasso commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

Superseded by #5275, which targets staging (per Waleed). Same README redesign, clean diff against staging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@andresdjasso