docs(readme): lead with a demo GIF, add quick-start example + star CTA#412
Open
PeterGuy326 wants to merge 2 commits into
Open
docs(readme): lead with a demo GIF, add quick-start example + star CTA#412PeterGuy326 wants to merge 2 commits into
PeterGuy326 wants to merge 2 commits into
Conversation
PeterGuy326
force-pushed
the
docs/readme-demo-gif-and-hero
branch
from
c38c2de to
77315df
Compare
Restructure the above-the-fold of both README.md and README_zh.md for discovery/conversion, without removing any information: - Replace the static product image with a ~15s animated demo GIF (recorded with VHS; real CLI output, no PII, ~200 KB) - Add a one-line value hook + a copy-pasteable quick-start example (all example commands verified against the current CLI) - Add a GitHub stars badge and a lightweight star CTA - Move the Co-creation / enterprise-auth IMPORTANT block down into Getting Started (kept verbatim, just no longer the first thing read) Rebased onto current main; command/product counts aligned to 330/18. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
PeterGuy326
force-pushed
the
docs/readme-demo-gif-and-hero
branch
from
3ee2158 to
f56de53
Compare
…ble tape
- Re-record demo GIF: the old one read "19 products · 334 commands",
which contradicted the README hero ("18 products · 330 commands") and
the 334 figure appeared nowhere else. New GIF shows the real
`--dry-run --jq` output (structured JSON) and the correct counts.
- Add docs/assets/dws-demo.tape so the GIF is actually reproducible (VHS).
- Star badge: drop style=social so it matches the flat release/CI/coverage row.
- Trim the above-the-fold star asks down to the single badge.
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
1 participant
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.
What & why
The README's above-the-fold currently opens with a static product image followed immediately by an enterprise-authorization
IMPORTANTblock. For a first-time visitor that buries the value proposition and leads with friction ("you need enterprise admin authorization") before they ever see why dws is useful — which hurts discovery and star conversion, especially for the global GitHub audience.This PR restructures the first screen for discovery/conversion, without removing any information.
Changes
dws contact user search … --dry-run,dws aisearch person … --dry-run), then the one-line product pitch..tapeis committed (docs/assets/dws-demo.tape) and reproducible withvhs docs/assets/dws-demo.tape.--dry-run, so nothing touches real enterprise data.docs/assets/dws-demo.gif(~182 KB).dws contact user search --query,dws calendar event list,dws aisearch person --query).IMPORTANTblock (with the DingTalk group QR) down into Getting Started — kept verbatim, just no longer the very first thing a visitor reads.Diff size
README.md/README_zh.mdrestructured above the fold, plus the GIF asset and its.tape. No content removed.Follow-ups (not in this PR)
--dry-runrequest preview instead).