Skip to content

docs: protect skill edits during contributor setup - #5346

Merged
miguel-heygen merged 5 commits into
heygen-com:mainfrom
user-github-me:docs/checkout-skills-install-safety
Oct 25, 2026
Merged

miguel-heygen merged 5 commits into
heygen-com:mainfrom
user-github-me:docs/checkout-skills-install-safety

Conversation

@user-github-me

@user-github-me user-github-me commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Contributor setup, the README and the skills guide distinguish global installs from project-local installs. Inside a HyperFrames source checkout, hyperframes skills update installs globally; project-local skills add belongs in a separate video project because its destination can overlap tracked skill sources and overwrite uncommitted edits.

The current-main integration preserves the consolidated skill descriptions and plugin guidance. Validation: checked the installer’s explicit global target, formatting, Mint documentation validation and broken links, normal commit hooks and both comment checks.

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approving. The three contributor entry points now carry the warning that until now lived only in CLAUDE.md:17.

I checked the core claim against the CLI: npx hyperframes skills update installs with --global --agent claude-code universal --copy (packages/cli/src/commands/skills.ts:112), so it never writes into the checkout's skills/. Its removed-skill cleanup also resolves the manifest with canonical: true (skills.ts:758-767), so running it from inside a checkout doesn't treat the local skills-manifest.json as the latest manifest. That makes it a safe command to recommend from a clone.

Small nits, none blocking:

  • README.md:56: the new paragraph sits between the install command and the "picker opens with nothing pre-selected" note that describes that command. Moving it below the note would keep the note next to its command.
  • skills update installs the core set, not all published skills. That's fine for contributors, and npx hyperframes skills is mentioned nearby, so nothing to change.

What I ran: read the diff in context in all three files, the CLI's install and prune paths, and the existing CLAUDE.md warning. Docs only, so there are no tests to run. CI is green. No overlapping open PR for #3862.

— Rames

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Still approving at the new head. The one change since my last review (e89528cd..00354a0b) takes up my README nit.

  • README.md:56-63: the "picker opens with nothing pre-selected" note now sits directly under npx skills add heygen-com/hyperframes, the command it describes. The contributor warning follows it, and its text is unchanged. It's a pure move: 4 lines added, 4 removed, same wording.
  • The CONTRIBUTING.md#getting-started link target still exists (## Getting Started, CONTRIBUTING.md:5).

No other changes. My earlier review had no blockers.

What I ran: diffed the previously reviewed commit against this head and read the README section in context. Docs only, so there were no tests to run. CI's docs validation passes. No other open PR targets #3862.

— Rames

@jrusso1020

Copy link
Copy Markdown
Collaborator

Thanks for this, @user-github-me. This PR now has merge conflicts with main. Could you rebase it onto the latest main? Once it's conflict-free we'll review it and get it into the merge queue.

@mintlify

mintlify Bot commented Oct 24, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 6b768bf.

Approve preview

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed at 6b768bf. Since the last approval at 00354a0 the branch only merged main and re-applied the same text: the three added paragraphs in CONTRIBUTING.md, README.md and docs/guides/skills.mdx are word for word what was approved, and only the lines around them changed with main.

I rechecked the claims against current main: npx hyperframes skills update still installs globally, the CONTRIBUTING.md#getting-started link target still exists, and both agent skills folders named in the text are in the checkout. The branch merges cleanly and CI is green.

Verdict: APPROVE
Reasoning: Same approved docs change on a clean, up-to-date base with green checks.

@miguel-heygen
miguel-heygen added this pull request to the merge queue Oct 25, 2026
Merged via the queue into heygen-com:main with commit 0289d96 Oct 25, 2026
103 checks passed
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.

3 participants