Skip to content

docs(skills): make reference guides directly discoverable - #5858

Merged
miguel-heygen merged 1 commit into
mainfrom
docs/skill-reference-navigation
Oct 18, 2026
Merged

miguel-heygen merged 1 commit into
mainfrom
docs/skill-reference-navigation

Conversation

@miguel-heygen

Copy link
Copy Markdown
Collaborator

What

Add explicit usage and reference navigation to the current HyperFrames skills. Motion graphics now starts with a “Use when” trigger; the HyperFrames router links directly to all 25 references, and the animation entry links to all 102 guides. Long guides have local contents links.

Why

An agent loading the entry skill could not discover the relevant animation recipe or route reference in one hop. #5651 remains open, so these are the currently shipped skills.

Related work

Refs #5651. Requested by Miguel in the skill-navigation report.

How

Add links, short reading cues and contents navigation while preserving workflow instructions. Refresh the generated skills manifest through the normal commit hook.

Test plan

  • Baseline retrieval failed for five representative targets; the same five pass after the change.
  • Verified 25/25 router and 102/102 animation targets, plus contents anchors.
  • Skill lint and mirror check pass; normal commit hooks pass.
  • Documentation updated; no visual product change.

What I measured

Direct-link coverage, local anchor validity, representative retrieval, and normalized prose preservation.

What I did NOT exercise

No composition was generated or rendered; workflow behavior is unchanged.

fails without the fix: the entry skill lacks direct links to the five tested reference targets, and motion-graphics lacks the explicit usage trigger.

@somanshreddy somanshreddy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Clean at ae906885: no blocker.

  • I checked every relative link and #anchor across the 60 changed .md files: 617 links, 0 broken. As a control, the checker does flag a planted missing file and a planted bad anchor.
  • Coverage holds. hyperframes/SKILL.md links all 25 files under the skill. hyperframes-animation/SKILL.md links all 102, plus one cross-skill link to ../hyperframes/references/plugin-installation.md, which resolves.
  • Apart from links, contents lists and headings, the diff adds one line: the motion-graphics description now starts "Use when". No CLI commands or flags were added, so there's no skill↔CLI version skew.
  • skills-manifest.json hashes are bumped for exactly the three skills that changed.

Nit (non-blocking): the generated route lines read "routing a embedded captions request", so the generator should pick "an" before a vowel.

— Somu

@miguel-heygen
miguel-heygen added this pull request to the merge queue Oct 18, 2026
Merged via the queue into main with commit 388011b Oct 18, 2026
58 checks passed
@miguel-heygen
miguel-heygen deleted the docs/skill-reference-navigation branch October 18, 2026 22:34
jbernard077 added a commit to jbernard077/hyperframes that referenced this pull request Oct 20, 2026
…entry

Upstream heygen-com#5858 added a per-rule list to hyperframes-animation/SKILL.md;
add the two rules this PR introduces in their alphabetical places.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
jbernard077 added a commit to jbernard077/hyperframes that referenced this pull request Oct 20, 2026
…nts table

Upstream heygen-com#5858 added a per-rule list to hyperframes-animation/SKILL.md and
contents tables to long guides; add this PR's rule to the list and the
table to rules/baked-sim.md.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.

2 participants