Skip to content

chore(readme): refresh demo GIFs from docs, lead with Mothership#4878

Merged
waleedlatif1 merged 1 commit into
stagingfrom
waleedlatif1/readme-docs-gifs
Jun 4, 2026
Merged

chore(readme): refresh demo GIFs from docs, lead with Mothership#4878
waleedlatif1 merged 1 commit into
stagingfrom
waleedlatif1/readme-docs-gifs

Conversation

@waleedlatif1
Copy link
Copy Markdown
Collaborator

Summary

  • Refreshed the README showcase media with new GIFs pulled from the docs, reordered to lead with Mothership (chat) as the hero
  • Demoted Workflows to a single section and folded Copilot into it; removed the standalone copilot.gif
  • Added files.gif (document generation) and a tables.png screenshot; replaced workflow.gif, knowledge.gif, mothership.gif
  • Re-encoded all GIFs much smaller (showcase media dropped from ~44MB to ~11MB)
  • Rewrote the hero tagline to brand language ("open-source AI workspace") and removed all em dashes

Type of Change

  • Chore / docs

Testing

Tested manually — verified every README image reference resolves to an existing asset and previewed each GIF.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 4, 2026 5:03pm

Request Review

@cursor
Copy link
Copy Markdown

cursor Bot commented Jun 4, 2026

PR Summary

Low Risk
Documentation-only README changes with no application or runtime impact.

Overview
Repositions the README around Sim as an “open-source AI workspace” and reorders the feature showcase so Mothership (chat) is the hero, followed by files/documents, knowledge, Tables, and Workflows last.

Media and copy updates: replaces/refreshes showcase GIFs (mothership.gif, files.gif, workflow.gif, knowledge.gif), adds tables.png, drops the standalone Copilot section (Copilot is described inside Workflows), and tweaks a minor Docker Compose docs sentence (punctuation only).

Reviewed by Cursor Bugbot for commit d90a4f5. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jun 4, 2026

Greptile Summary

This PR refreshes the README showcase media and rewrites the hero section to lead with Mothership (the chat-based AI command center) instead of the visual workflow builder. All GIFs were re-encoded at dramatically smaller sizes, reducing total showcase media from ~44 MB to ~11 MB.

  • Reordered sections: Mothership → Files → Knowledge → Tables → Workflows, reflecting the product's primary entry points.
  • Media update: copilot.gif removed, files.gif/mothership.gif/tables.png added; knowledge.gif compressed from ~21 MB to ~439 KB, workflow.gif from ~17 MB to ~3.8 MB.
  • Copy refresh: Hero tagline updated to "open-source AI workspace" branding; em dashes removed per PR description.

Confidence Score: 5/5

Documentation-only change — no application code is modified, all image references resolve to existing assets, and the deleted copilot.gif has no remaining references in the codebase.

All changed files are README copy and static media assets. Every image path referenced in the updated README was verified to exist on disk, and the removed copilot.gif has no other references anywhere in the repository.

No files require special attention.

Important Files Changed

Filename Overview
README.md Section order changed to lead with Mothership; new sections for files and tables added; all image references verified to resolve to existing assets.
apps/sim/public/static/copilot.gif File deleted (4.6 MB to 0 bytes); no remaining references found in the codebase.
apps/sim/public/static/files.gif New 2.7 MB GIF added for document-generation showcase.
apps/sim/public/static/knowledge.gif Re-encoded from 20.7 MB to 429 KB, a 98% size reduction.
apps/sim/public/static/mothership.gif New 1.5 MB GIF added as the hero showcase for Mothership chat.
apps/sim/public/static/tables.png New 287 KB PNG screenshot added for the Tables feature.
apps/sim/public/static/workflow.gif Re-encoded from 16.6 MB to 3.7 MB, a 78% size reduction.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README Hero Section] --> B[Mothership GIF]
    A --> C[Files GIF]
    A --> D[Knowledge GIF]
    A --> E[Tables PNG]
    A --> F[Workflow GIF]
    G[copilot.gif] -->|deleted| X[removed]
Loading

Reviews (1): Last reviewed commit: "chore(readme): refresh demo GIFs from do..." | Re-trigger Greptile

@waleedlatif1 waleedlatif1 merged commit 402472e into staging Jun 4, 2026
14 checks passed
@waleedlatif1 waleedlatif1 deleted the waleedlatif1/readme-docs-gifs branch June 4, 2026 17:06
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