Skip to content

docs(readme): polish quickstart — That's it\!, restart-and-ask, supported-clients as a Note callout#89

Merged
naorsabag merged 2 commits into
masterfrom
fix/readme-quickstart-callout
May 8, 2026
Merged

docs(readme): polish quickstart — That's it\!, restart-and-ask, supported-clients as a Note callout#89
naorsabag merged 2 commits into
masterfrom
fix/readme-quickstart-callout

Conversation

@naorsabag
Copy link
Copy Markdown
Owner

@naorsabag naorsabag commented May 8, 2026

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:

"Walk me through the main flow of this codebase."

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:

"Walk me through the main flow of this codebase."

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

Change Why
Moved supported-clients aside out of the install lead-in into a > [\!NOTE] callout at section bottom Keeps the install line focused on the action; GitHub renders [\!NOTE] as a blue info-callout
Added That's it! between command and next-step Marks completion of the install step naturally
"Restart your agent…, then open your codebase and ask" → "Now restart your agent…, and ask" Flows better after the bolded "That's it!"

Testing

`npx prettier --check README.md` → clean.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reworked the "Try it in 60 seconds" quickstart: clearly labeled the Install step, preserved the example command block, and converted the previous inline auto-detection note into a prominent callout that directs other clients to the Install section for clarity.

…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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: a201143d-275f-4b7c-90ae-3d7f0ab4242f

📥 Commits

Reviewing files that changed from the base of the PR and between 4fcfe92 and 6bf5c3c.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Walkthrough

README's "Try it in 60 seconds" section is reformatted with an "Install the skill:" label and an npx openhop init command. The auto-detection guidance is converted to a GitHub blockquote note that directs other clients to the Install section.

Changes

Quick Start Section Update

Layer / File(s) Summary
Quick Start Section Formatting
README.md
"Try it in 60 seconds" section adds explicit "Install the skill:" label, preserves npx openhop init command, and converts auto-detection guidance into a [!NOTE] blockquote with link to Install section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • naorsabag/openhop#87: Both PRs edit README installation/quickstart text and the Install/Use cases framing, so their changes overlap and are related.
  • naorsabag/openhop#72: Both PRs modify the README’s quickstart/install wording around the "npx openhop init" / install rows.
  • naorsabag/openhop#88: Both PRs modify the README's "Try it in 60 seconds" quickstart and install sections, preserving the npx openhop init flow and adjusting the note.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes to the README quickstart section, including the three key edits (install label polish, 'That's it!' insertion, and moving supported-clients to a Note callout).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-quickstart-callout

Comment @coderabbitai help to get the list of available commands and usage tips.

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>
@naorsabag naorsabag merged commit e42870c into master May 8, 2026
7 checks passed
@naorsabag naorsabag deleted the fix/readme-quickstart-callout branch May 10, 2026 17:38
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