docs: redesign README header for first-5-seconds hook#79
Merged
Conversation
The first impression decided no stars. The header lead was "comprehensive configuration suite" — abstract, doesn't tell a visitor why this repo is different from vanilla Gemini CLI. The Quick Start also had a broken code fence (a stray naked `npm install` line and a runaway four-backtick block) that rendered ugly on GitHub. Changes (README.md only, no source/code edits): - New tagline: "Battle-tested agents, skills, and workflows for Gemini CLI / Antigravity." Then a one-line differentiator paragraph that names the upstream port AND the Gemini-native killer feature (/egc-grok, 1M context vs Claude Code's 200K). - Stats badges added next to license: skills 183, agents 48, commands 80. Concrete numbers, scannable at a glance. - New "What you can do" section with five concrete bullets, each naming a real command or agent: /egc-grok, @Planner, /egc-tdd + @tdd-guide, @security-reviewer, 183 skills on-demand. All five entry points cross-checked against the repo before this commit — they exist. - Quick Start collapsed to a single one-line `gemini extensions install` command + the API key env var. The four other install paths (Antigravity script, manual copy, dev-mode link, uninstall variants) move into a single <details> fold so they're still there but no longer push the value prop below the fold. - Broken markdown fences in the old Quick Start cleaned up. - Usage / What's Inside / Troubleshooting / Contributing / License sections untouched. Counts will drift; refresh when releases bump skill/agent inventory by more than ~5%. (Could shields.io-dynamic these later if it becomes a recurring maintenance ask.) npm run lint clean. npm test 279/279.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughRoot README and localized Korean/Chinese READMEs rewritten to present Gemini CLI/Antigravity branding, capability bullets, a streamlined Quick Start using ChangesDocumentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 50-56: The README currently demonstrates running the installer
directly from the main branch via curl | bash which is unsafe; update the
example invocations to reference a pinned release tag or specific commit SHA in
the URLs (replace ".../main/scripts/install.sh" with
".../refs/tags/vX.Y.Z/scripts/install.sh" or
".../commit/<SHA>/scripts/install.sh") and add a note to verify a published
checksum/signature for that release (or link to a checksum file next to the
release) before executing; reference the install script name install.sh and the
example curl command so reviewers can locate and update those lines and include
brief instructions to prefer downloading the release artifact and verifying
integrity instead of piping to bash.
- Around line 54-56: Add an uninstall example showing the shared uninstall
script invoked with the --all flag so readers know it removes both CLI and
Antigravity; update the "CLI + Antigravity" section in README.md to include a
parallel example to the install line that runs the uninstall script with --all
(same script URL used in the install example) and a brief note that --all
removes both components, alongside the existing --antigravity example.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: d2704d9c-76ea-4f73-8676-3714d59f6f5d
📒 Files selected for processing (1)
README.md
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
P1 — curl | bash from `main` is unsafe (CodeRabbit, line 56): All five `raw.githubusercontent.com/.../main/scripts/*` URLs pinned to `refs/tags/v1.3.12`. Avoids the supply-chain risk of installer drift between releases. Added a brief explanatory note linking to the blob URL so readers can audit the script before piping to bash. P2 — uninstall --all flag undocumented (CodeRabbit, line 56): The install section showed `--all` (CLI + Antigravity) but the uninstall section only showed `--antigravity`. Verified scripts/uninstall.sh:28 supports `--all` (sets both TARGET_ANTIGRAVITY and TARGET_CLI). Added a parallel uninstall --all example and tightened the comment labels for the three uninstall variants (Antigravity only / CLI + Antigravity / full Antigravity purge). Bump cadence: when the next release tag lands, run `sed -i '' 's|refs/tags/v1.3.12|refs/tags/v1.3.13|g' README.md` or similar. Could be automated in scripts/release.sh as a follow-up if this becomes recurring. npm run lint clean.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 52-55: The README contains installer curl commands pinned to a
non-existent tag "refs/tags/v1.3.12" which will cause installs to fail; update
the URLs in the README to point to a valid ref by either creating the v1.3.12
tag that includes scripts/install.sh and scripts/uninstall.sh or change the
pinned ref to a known good branch/tag (e.g., "main" or the current release tag)
wherever "refs/tags/v1.3.12" appears around the installer lines and for both
scripts/install.sh and scripts/uninstall.sh invocations.
- Around line 11-13: The README's skills badge currently shows "skills-183" and
should be updated to "skills-284"; locate the badge markdown line that contains
"" and change the
URL/text segment to ""
so the badge reflects the correct inventory count.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: e4630a55-b250-4a99-b83e-839f61c94712
📒 Files selected for processing (1)
README.md
The English README redesign in this PR (new header, badges, "What
you can do", collapsed Quick Start, tag-pinned curl URLs, --all
uninstall) was applied to docs/ko-KR/README.md and
docs/zh-CN/README.md so non-English visitors see the same first-
5-seconds hook and the same supply-chain-safe install commands.
Per-mirror changes:
docs/ko-KR/README.md
- Stats badges added (skills-183, agents-48, commands-80) next
to the existing language-stack badges.
- Tagline rewritten: "Gemini CLI / Antigravity 를 위한 검증된
에이전트, 스킬, 워크플로우 모음." + a Gemini-native
differentiator paragraph naming the 1M-context advantage.
- New "무엇을 할 수 있나" section with the same five concrete
bullets as English (/egc-grok, @Planner, /egc-tdd, etc).
- Quick Start collapsed: one extension-install line + API key
+ everything else (script-based, manual notes, uninstall
variants) inside a <details> fold.
- 4 curl URLs in install + 3 uninstall URLs pinned to
refs/tags/v1.3.12; uninstall --all example added.
- Stale inventory counts fixed: 28→48 agents, 125→183 skills,
60→80 commands (3 locations in "구성 요소" section).
docs/zh-CN/README.md
- Stats badges added (skills-183, agents-48, commands-80).
- Tagline rewritten with Gemini-native framing.
- New "你能做什么" section with the same five bullets in
Simplified Chinese.
- Quick Start collapsed identically to English (single
extension-install + API key + <details> fold).
- 5 curl URLs pinned to refs/tags/v1.3.12; uninstall --all
example added.
Untouched in both:
- Language nav (line 1)
- Attribution + ecosystem-port disclaimer (lines 3-5, already
polished from upstream feedback round)
- Below-the-fold sections (사용 예시, 구성 요소,
Troubleshooting equivalents, Contributing, License)
npm run lint clean.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/zh-CN/README.md`:
- Around line 43-96: The zh-CN README is missing a "First Command" section that
highlights the Gemini-native `/egc-grok` command (creating inconsistency with
ko-KR); add a short "首次命令" or "第一个命令" block immediately after the existing
installation details (after the </details> closing) that mirrors the ko-KR
content: show `/egc-grok` as the first example, include examples for direct
agent calls like `@architect "设计微服务架构"` and `@security-reviewer "审计此文件的注入漏洞"`,
and include the Antigravity note explaining the `egc-` prefix behavior and
conflicts with `/plan` (so readers see `/egc-grok`, `/egc-plan`, `/egc-tdd`
order and the prefix guidance).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3909afe2-08b8-415d-89c3-35801453e761
📒 Files selected for processing (2)
docs/ko-KR/README.mddocs/zh-CN/README.md
CodeRabbit (PR #79 round 3) flagged the zh-CN README as missing the post-install "First Command" hook that ko-KR has. Adds the section in the same position (immediately after the install <details> fold, before the dedicated 使用方法 section) so the zh-CN reader sees the same first-command suggestion (/egc-grok) and the same Antigravity prefix note as the Korean reader. Mirrors ko-KR's content: - /egc-grok as the first example (whole-repo audit) - /egc-plan + /egc-tdd as workflow entry points - @architect + @security-reviewer for direct agent calls - Antigravity bare-name vs egc- prefix explanation npm run lint clean.
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.
Summary
Reshapes the top of the README so a first-time visitor sees what makes EGC different in 5 seconds instead of scrolling past 4 install options to find out. Also fixes a broken
npm installcode fence that's been rendering as raw text on GitHub.What changes
New header lead
Before:
After:
Stats badges
Added next to license:
skills-183,agents-48,commands-80. Static for now; refresh when inventory drifts ~5%+. Could move to dynamic shields.io if maintenance becomes a recurring ask.New "What you can do" section
Five bullets, each naming a real command or agent (all cross-checked against the repo):
/egc-grok— whole-repo audit (1M context)@planner— phased plan + WAIT-for-confirm/egc-tdd+@tdd-guide— TDD with 80%+ coverage@security-reviewer— OWASP top 10 + secretsQuick Start collapsed to a single command
Before: 4 install options + auth + uninstall variants, all expanded inline → ~80 lines before reaching Usage.
After: one line (
gemini extensions install <repo>) + API key env var. Everything else (script-based install, manual copy, dev-mode link, all uninstall variants) moved into a single<details>fold. Still discoverable, no longer pushes the value prop below the fold.Broken markdown cleaned up
The old Quick Start had a naked
npm install -g @google/gemini-cli@latestline floating outside any code block, and a stray four-backtick fence. Rendered as raw text on GitHub. Gone.Untouched
Risks
Test plan
npm run lintclean (markdownlint included)npm test279/279commands/andagents/Summary by cubic
Redesigned the README header across English, Korean, and Chinese to surface the “why” in 5 seconds and streamline install. Pinned all script URLs to
v1.3.12, documented the--alluninstall path, and added a “First Command” section to zh-CN for parity.New Features
/egc-grokcallout./egc-grok,@planner,/egc-tdd+@tdd-guide,@security-reviewer, on-demand skills.gemini extensions install …+GEMINI_API_KEY; other methods in a single details fold; mirrored indocs/ko-KR/README.mdanddocs/zh-CN/README.md.docs/zh-CN/README.mdwith/egc-grok,/egc-plan,/egc-tdd, and the Antigravity prefix note.Bug Fixes
npm installline.curl | bashURLs torefs/tags/v1.3.12with a short audit note; mirrored in KO/ZH.--alluninstall and aligned uninstall examples/labels (selective and purge variants).Written for commit 566052a. Summary will update on new commits.
Summary by CodeRabbit