docs(readme): polish quickstart — That's it\!, restart-and-ask, supported-clients as a Note callout#89
Merged
Merged
Conversation
…rted-clients as a note Three changes per request: 1. Move the "(auto-detects Claude Code, Cursor, Windsurf, Cline, Continue — for other clients see Install)" parenthetical out of the install-command lead-in and into a `> [\!NOTE]` callout at the bottom of the section. The install line is now just "Install the skill:" followed by the command. 2. Add "**That's it\!**" between the install command and the next step to call out the natural completion point. 3. Reword the next sentence from "Restart your agent so it picks up the new skill, then open your codebase and ask:" to "Now restart your agent so it picks up the new skill, and ask:" — flows better after the bold "That's it\!". GitHub renders `> [\!NOTE]` as a styled callout (blue info box) that visually separates the supported-clients aside from the main step. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughREADME's "Try it in 60 seconds" section is reformatted with an "Install the skill:" label and an ChangesQuick Start Section Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 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)
Comment |
Per request — gives the bolded completion marker its own visual beat before the next-step instruction. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
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
Three readability tweaks to the "Try it in 60 seconds" section.
Before
```
Try it in 60 seconds
Install the skill (auto-detects Claude Code, Cursor, Windsurf, Cline, Continue — for other clients see Install):
```bash
npx openhop init
```
Restart your agent so it picks up the new skill, then open your codebase and ask:
The agent generates the YAML, pushes it, and returns a URL with the animation playing.
```
After
```
Try it in 60 seconds
Install the skill:
```bash
npx openhop init
```
That's it! Now restart your agent so it picks up the new skill, and ask:
The agent generates the YAML, pushes it, and returns a URL with the animation playing.
Note
`npx openhop init` auto-detects Claude Code, Cursor, Windsurf, Cline, and Continue.
For other clients, see Install.
```
What changed
> [\!NOTE]callout at section bottom[\!NOTE]as a blue info-calloutTesting
`npx prettier --check README.md` → clean.
🤖 Generated with Claude Code
Summary by CodeRabbit