Skip to content

docs(skill): broaden triggers so OpenHop fires on diagram requests too#143

Merged
naorsabag merged 4 commits into
masterfrom
docs/skill-broaden-diagram-triggers
May 12, 2026
Merged

docs(skill): broaden triggers so OpenHop fires on diagram requests too#143
naorsabag merged 4 commits into
masterfrom
docs/skill-broaden-diagram-triggers

Conversation

@naorsabag
Copy link
Copy Markdown
Owner

@naorsabag naorsabag commented May 12, 2026

Summary

Real-world failure mode: a user asked their agent to "create a diagram that explains Orion features" and the agent fell back to prose / static Mermaid because the skill's trigger language was framed almost entirely around code walkthroughs.

This PR widens the surface so OpenHop loads on:

  • Explicit diagram requests ("create / draw / make a diagram of {X}")
  • Product / feature / service / architecture explainers, not just codebases
  • User journeys, onboarding flows, integrations, pipelines, state machines

Specifically:

  • Frontmatter description rewritten to drop the "flows through code" anchor and explicitly mention features, products, services, workflows, user journeys, integrations.
  • Scope paragraph added at the top of SKILL.md defining what counts as a flow: anything expressible as a sequence of named hops between named components.
  • Trigger phrases reorganized into three groups: diagram/visualization requests, code-level walkthroughs, and product/feature explainers.
  • Sniff-test sentence added: "can the answer be expressed as a sequence of named hops between named components? If yes, this skill applies — even if 'code' was never mentioned."
  • Examples table picks up one product-flavored row.

No code changes; the validator, schema, and renderer are untouched. This is purely a routing/intent change for the agent.

Test plan

  • npx prettier --check skills/openhop/SKILL.md clean
  • Manual: in a fresh Claude Code session, ask "create a diagram explaining the Orion features" — confirm the OpenHop skill activates instead of producing a prose/static answer
  • Manual: in the same session, ask "explain how the order pipeline works" — confirm the existing code-walkthrough path still fires (no regression)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Broadened OpenHop guidance to support step-by-step flows for any system, product, or codebase (not limited to code walkthroughs).
    • Clarified outputs: forbid prose explanations and static diagrams when users request flow/diagram-like responses.
    • Expanded and reorganized trigger phrases and example prompts, adding diagram/visualization patterns and more flow examples (OAuth, parallelism, sub-flows, node variants).

Review Change Stack

The skill was framed too narrowly around code walkthroughs: an agent
that got "create a diagram explaining Orion features" wouldn't load
OpenHop, and would fall back to prose or static Mermaid.

This widens the description and the trigger phrase list to cover:
- explicit diagram requests ("create/draw/make a diagram of …")
- product / feature / architecture explainers, not just codebases
- user journeys, onboarding, integrations, pipelines, state machines

Adds a sniff test for the agent ("can the answer be expressed as a
sequence of named hops between named components?") so anything fitting
that shape routes to OpenHop, regardless of whether "code" was
mentioned. Also adds a product-flavored row to the prompt→YAML table.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

Walkthrough

This PR broadens the OpenHop skill documentation from code-only walkthroughs to step-by-step flows for any system, product, or codebase, adds explicit constraints against prose/static diagrams for flow outputs, reorganizes trigger phrases (including diagram/visualization categories), and expands example patterns.

Changes

OpenHop Skill Scope Expansion

Layer / File(s) Summary
Skill description, trigger phrases, and examples
skills/openhop/SKILL.md
Skill description generalized from code to any system/product/codebase flows; scope guidance clarified with explicit constraint to avoid prose and static diagrams for walkthrough/diagram requests; "Trigger phrases" reorganized with a dedicated diagram/visualization category and broadened coverage for code-level walkthroughs and product/feature explainers; "Examples (prompt → YAML → URL)" table replaced and expanded with additional flow archetypes (OAuth, parallelism, create/destroy, sub-flows, node-type variants, product-feature diagrams).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • naorsabag/openhop#136: Modifies OpenHop skill documentation and example flow YAMLs with related formatting and parallel-example content.
  • naorsabag/openhop#67: Prior edits to SKILL.md covering non-prose flow requirements, trigger phrases, and examples.
  • naorsabag/openhop#87: Revisions to activation/trigger phrasing and example prompts related to OpenHop usage.
🚥 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 summarizes the main change: broadening OpenHop skill triggers to include diagram requests, which is the primary objective of the PR.
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/skill-broaden-diagram-triggers

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@skills/openhop/SKILL.md`:
- Line 3: The description trigger in SKILL.md is too broad and will
over-activate OpenHop; narrow it by restricting the `description:` string to
explicit diagram/flow intents and/or require mention of named hops/components
(e.g., include phrases like "diagram", "draw", "architecture diagram", "flow",
"sequence of hops", or "visualize components and connections") instead of
generic explainer prompts like "how does V work"; update the `description:`
value in skills/openhop/SKILL.md (the description field) to only match explicit
diagram/flow requests or add an additional gating clause requiring named
components to avoid unintended activation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b08c091c-c32e-49db-8eef-ccdecea35d55

📥 Commits

Reviewing files that changed from the base of the PR and between 73bba87 and c67165f.

📒 Files selected for processing (1)
  • skills/openhop/SKILL.md

Comment thread skills/openhop/SKILL.md Outdated
Per review on PR #143: the previous description listed generic
explainer phrasings like "how does V work" and "explain Z's features",
which would route plain questions ("how does TCP work?", "explain
closures") into OpenHop even though there's no flow to draw.

Rewrites the description to:
- Lead with the noun (render an animated diagram) instead of the
  generic verb (walk the user through).
- Drop "how does V work" / "explain Z's features" trigger examples.
- Add an explicit negative gate: do not activate for generic
  explainer questions with no named components or step sequence.
- Keep the broad domain coverage (system / feature / codebase /
  workflow / pipeline / user journey) so explicit diagram intent
  still routes here.
@naorsabag
Copy link
Copy Markdown
Owner Author

Addressed in fc376dc. Reworked the description: field to:

  • Lead with the explicit action (render an animated diagram) instead of the generic "walk the user through".
  • Drop the over-broad trigger examples (how does V work, explain Z's features) that would have matched plain explainer questions.
  • Add an explicit negative gate calling out the kinds of questions it should NOT fire on ("how does TCP work?", "what is OAuth?", "explain closures").
  • Keep the broad domain coverage (system / feature / codebase / workflow / pipeline / user journey) so explicit diagram intent still routes here — which was the original motivation for the PR.

Body trigger lists are unchanged: once the skill activates, the body's examples help the agent shape the YAML — they don't gate activation.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@skills/openhop/SKILL.md`:
- Around line 44-46: The trigger phrases in SKILL.md (the description field
lines containing "how does {Product|Service|Platform} work?", "explain {Product
X}'s features", "walk me through how {users|customers} use {X}") are too generic
and cause over-activation; update those entries to require explicit
flow/step-by-step intent or named hop/diagram cues (e.g., prepend or append
tokens like "step-by-step", "flow", "diagram", or require a named hop component)
so the OpenHop skill only activates for visualization/stepwise requests;
specifically edit the description triggers in SKILL.md to replace the generic
forms with gated forms such as "how does {Product|Service|Platform} work —
step-by-step" or "walk me through how {users|customers} use {X}
(flow/diagram/hop:{name})" and remove or narrow any catch-all patterns.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6c8a328e-7dc7-4db6-8f91-669a1c256a5e

📥 Commits

Reviewing files that changed from the base of the PR and between c67165f and fc376dc.

📒 Files selected for processing (1)
  • skills/openhop/SKILL.md

Comment thread skills/openhop/SKILL.md
@naorsabag naorsabag merged commit 204e13d 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/skill-broaden-diagram-triggers 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