docs(readme): align with launch-plan skeleton#124
Merged
Conversation
Addresses four gaps from `openhop-launch/03-readme-and-landing.md`: 1. **Local-first sub-line in the hero.** Was buried in Features bullet #6 ("Local-first, no telemetry"). The skeleton calls it out as a dedicated conversion-driver sub-line: "Local-first. Your code never leaves your machine. No telemetry." 2. **`/docs` + Discord links in the header nav.** Skeleton line 188: "Docs signal 'this is serious.'" Docs link goes to the Pages playground (the live, working docs surface today); Discord placeholder points at the canonical openhop invite from the skeleton. 3. **Claude Code native plugin install path (`/plugin install naorsabag/openhop`).** Added as Path C alongside `npx openhop init` and OpenSkills, with the `[Y/n]`, `--yes`, and `--skip-cli` flags documented per skeleton. 4. **Architecture note as a standalone block.** Inline GFM `> [\!IMPORTANT]` callout at the bottom of Install Options, restating the local-first promise in the specific shape the skeleton recommends. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
WalkthroughREADME.md was enhanced with navigation updates, a local-first branding callout beneath the logo, a new Claude Code plugin installation path, and clarifying architecture documentation. The changes add community links and expand installation and sharing guidance without altering code functionality. ChangesDocumentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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)
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 |
Two refinements on top of the launch-skeleton alignment:
- Stripped the `[Y/n]` / `--yes` / `--skip-cli` text from the
Claude Code plugin install block. Those flag names were carried
forward from the launch-plan skeleton but aren't actually
Claude Code `/plugin` CLI flags — keeping them in invented
contract.
- Created docs/ as an in-repo doc surface so the "Docs" header
link points somewhere real. Initial pages:
docs/README.md — index
docs/install.md — every install path, per-client
docs/yaml.md — full schema reference (sourced from
zod + SKILL.md)
docs/cli.md — every CLI command + flag (sourced
from packages/cli/src/index.ts)
docs/architecture.md — what runs where + the local-first
guarantees
Also: clarified that `/plugin install naorsabag/openhop` is
Claude Code-specific. Cursor / Windsurf / Cline have their own
extension surfaces and reach OpenHop via Path A (`npx openhop init`)
or Path B (OpenSkills).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ystem
Earlier wording implied Cursor "uses native skills" *instead of* having
plugins. That undersells Cursor — it has a full plugin marketplace
(Settings → Marketplace, team marketplaces, cursor.directory, MCP
deeplinks). What it doesn't have is an ad-hoc `/plugin install
<github-repo>` slash command equivalent to Claude Code's.
Reword Path C in both README.md and docs/install.md to say:
- the *syntax* `/plugin install naorsabag/openhop` is CC-specific
- Cursor / Windsurf / Cline reach OpenHop via Path A (native skills
surface), and Cursor users can also discover it via their
marketplace once we list it
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
… paragraph Per feedback, Path C is just a command + "…or from your agent GUI" — no per-client breakdown of plugin surfaces in this section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…cal-first callout
This was referenced May 11, 2026
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.
Addresses the four gaps you flagged against `openhop-launch/03-readme-and-landing.md`.
🤖 Generated with Claude Code
Summary by CodeRabbit