docs(readme): swap features for live demo, sharing, and token-use sections#140
Merged
Conversation
…tions - Rewrite Why bullets to lead with the animated step-through + drill-down differentiation versus static Mermaid/PlantUML pictures. - Drop the Features list and add a Live demo section pointing at the GitHub Pages playground. - Add a Sharing flows section that documents the URL-fragment share path through the Pages deploy. - Add a Token use section with an estimated-token table for three example flows and a ranged prose-comparison claim. - Refresh the TOC to match.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughREADME.md content updated: top navigation links reorganized; the hero tagline added “Token-light”; the "Why" section rewritten to describe animated, step-through, multi-level YAML-rendered data-flows; new "Live demo" and "Token use" sections added; and a "Sharing flows" section documents URL-hash sharing and large-flow sharing guidance. ChangesREADME Documentation Updates
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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)
Warning Review ran into problems🔥 ProblemsTimed out fetching pipeline failures after 30000ms 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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
1-242:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winCI pipeline blocked by Prettier formatting violations.
All CI jobs are failing because the README does not match Prettier's formatting rules. Run
prettier --write README.mdto fix before merging.🤖 Prompt for 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. In `@README.md` around lines 1 - 242, CI is failing because README.md doesn't match Prettier formatting; run Prettier to reformat the file and commit the result. Fix: run prettier --write README.md (or your repo's npm script like npm run format) locally, review the changed README.md edits, stage and commit them so the CI Prettier check passes; locate the README's top-level headings and badge/image blocks (the "OpenHop" title and the badge/image sections) when verifying the formatted output.
🤖 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.
Outside diff comments:
In `@README.md`:
- Around line 1-242: CI is failing because README.md doesn't match Prettier
formatting; run Prettier to reformat the file and commit the result. Fix: run
prettier --write README.md (or your repo's npm script like npm run format)
locally, review the changed README.md edits, stage and commit them so the CI
Prettier check passes; locate the README's top-level headings and badge/image
blocks (the "OpenHop" title and the badge/image sections) when verifying the
formatted output.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: c4a875ee-373f-45ed-af0b-e7842952df6d
📒 Files selected for processing (1)
README.md
This was referenced May 12, 2026
naorsabag
added a commit
that referenced
this pull request
May 13, 2026
Cuts the first release since v0.2.0 on 2026-05-11. The publish workflow auto-publishes each package whose package.json version differs from the registry, then tags v0.3.0 and creates the GitHub release. Versions: - @openhop/server 0.2.0 -> 0.3.0 - @openhop/web 0.2.0 -> 0.3.0 - openhop (CLI) 0.2.0 -> 0.3.0 - CLI's pinned deps on server + web also bumped to 0.3.0. CHANGELOG: promotes the existing [Unreleased] block to [0.3.0] with the two user-visible shipping changes since v0.2.0: - Skill triggers broadened (#143) — diagram / visualization / walkthrough prompts about products, features, workflows, user journeys, etc. now route to OpenHop, not just code walkthroughs. Adds an explicit negative gate to keep generic explainer prompts ("how does TCP work?") from over-activating the skill. - INSPECT panel defaults to bottom-dock on mobile (#142) — narrow viewports keep the canvas full-width when the user opens the inspector. plumbing and not changelogged. #140 / #141 only touched the README and do not ship in any tarball.
naorsabag
added a commit
that referenced
this pull request
May 13, 2026
* chore: bump @openhop/server @openhop/web openhop to 0.3.0 Cuts the first release since v0.2.0 on 2026-05-11. The publish workflow auto-publishes each package whose package.json version differs from the registry, then tags v0.3.0 and creates the GitHub release. Versions: - @openhop/server 0.2.0 -> 0.3.0 - @openhop/web 0.2.0 -> 0.3.0 - openhop (CLI) 0.2.0 -> 0.3.0 - CLI's pinned deps on server + web also bumped to 0.3.0. CHANGELOG: promotes the existing [Unreleased] block to [0.3.0] with the two user-visible shipping changes since v0.2.0: - Skill triggers broadened (#143) — diagram / visualization / walkthrough prompts about products, features, workflows, user journeys, etc. now route to OpenHop, not just code walkthroughs. Adds an explicit negative gate to keep generic explainer prompts ("how does TCP work?") from over-activating the skill. - INSPECT panel defaults to bottom-dock on mobile (#142) — narrow viewports keep the canvas full-width when the user opens the inspector. plumbing and not changelogged. #140 / #141 only touched the README and do not ship in any tarball. * docs(changelog): add [0.3.0] link ref + point [Unreleased] at v0.3.0
4 tasks
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
simple-crud,auth-flow,order-flow) showing estimated YAML tokens, plus a ranged 5–15× claim against an agent's prose walkthrough. Estimates are framed as estimates (≈ 1 token / 4 chars), not measurements — happy to swap in realcl100k_basenumbers in a follow-up if preferred.Live demo,Token use,Sharinganchors added).No behavior or schema changes; README-only.
Test plan
examples/*.yaml).🤖 Generated with Claude Code
Summary by CodeRabbit