Skip to content

docs(readme): move Sharing flows before Install Options#141

Merged
naorsabag merged 1 commit into
masterfrom
docs/readme-reorder-sharing-before-install
May 12, 2026
Merged

docs(readme): move Sharing flows before Install Options#141
naorsabag merged 1 commit into
masterfrom
docs/readme-reorder-sharing-before-install

Conversation

@naorsabag
Copy link
Copy Markdown
Owner

@naorsabag naorsabag commented May 12, 2026

Summary

Reorders the README so Sharing flows sits before Install Options — and updates the TOC anchor strip to match. This change was made on PR #140 but didn't make it in before the squash-merge, so opening as its own follow-up.

New section order: Quickstart → Live demo → Token use → SharingInstall → Use cases → CLI → How it works → Examples.

Test plan

  • Eyeball the rendered README on GitHub: TOC anchors land on the right sections, Sharing flows now appears before Install Options.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reordered navigation links to prioritize sharing flows information earlier.
    • Reorganized sharing flows section to appear earlier in the documentation with details on sharing via web playground URL hash and YAML file.
    • Removed duplicate sharing flows section to eliminate redundancy.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

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: 8c0c38c5-e4a9-4ce0-a0c2-8fd171e44607

📥 Commits

Reviewing files that changed from the base of the PR and between dd66868 and d81d48a.

📒 Files selected for processing (1)
  • README.md

Walkthrough

README.md is reorganized to consolidate sharing documentation. The quickstart navigation links are reordered to surface "Sharing" before "Install," a new "Sharing flows" section is added describing URL-hash and YAML sharing methods, and the older duplicate "Sharing flows" section is removed to avoid repetition.

Changes

Documentation reorganization

Layer / File(s) Summary
Reorganize sharing documentation
README.md
Navigation links are reordered so "Sharing" precedes "Install." A new "Sharing flows" section is added describing local-first sharing via the playground's URL-hash links and an alternative for large flows shared as YAML files. The older duplicate "Sharing flows" section that appeared before "Use cases" is removed.

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • naorsabag/openhop#140: Both PRs modify README.md's navigation and consolidate the "Sharing flows" content.
  • naorsabag/openhop#125: Both PRs modify README.md's Quickstart area and reorder navigation anchors.
  • naorsabag/openhop#124: Both PRs reorganize README documentation around sharing and consolidate the "Sharing flows" section.
🚥 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 clearly and specifically describes the main change: reordering the README to move the 'Sharing flows' section before 'Install Options', which matches the changeset's primary objective.
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 docs/readme-reorder-sharing-before-install

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.

❤️ Share

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

@naorsabag naorsabag merged commit bebab3f into master May 12, 2026
8 checks passed
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
@naorsabag naorsabag deleted the docs/readme-reorder-sharing-before-install branch May 15, 2026 16:00
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