Revamp README with visuals, examples, and shell tour - #3
Draft
ericcayers-ai wants to merge 2 commits into
Draft
Conversation
Add compressed hero and UI mockups plus architecture/vertical-slice SVGs under docs/assets/readme, and reshape the README for scannable workflow-first storytelling while keeping setup and contract detail. Co-authored-by: Eric Ayers <ericcayers-ai@users.noreply.github.com>
Co-authored-by: Eric Ayers <ericcayers-ai@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Visual README revamp using impeccable (brand register), bencium-controlled-ux (clarity / hierarchy), and frontend-design (distinctive product storytelling).
Adds hero + shell mockups, architecture / vertical-slice diagrams, example goal + Workflow IR, and a scannable activity-rail tour while keeping setup, contract, and docs map intact.
Assets
docs/assets/readme/hero-banner.jpgdocs/assets/readme/shell-workflow.jpg/shell-notes.jpgdocs/assets/readme/architecture.svg/vertical-slice.svgdocs/assets/readme/app-icon.pngTest plan
v0.1.2Docs
.cursor/plans/editsBreaking changes