Skip to content

docs: drop --full-depth from skills install commands - #3399

Merged
miguel-heygen merged 2 commits into
mainfrom
miguel-heygen-patch-1
Aug 21, 2026
Merged

docs: drop --full-depth from skills install commands#3399
miguel-heygen merged 2 commits into
mainfrom
miguel-heygen-patch-1

Conversation

@miguel-heygen

@miguel-heygen miguel-heygen commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

What

Removes --full-depth from every npx skills add command we document, and drops the prose that told readers to keep the flag.

Files: README.md, CLAUDE.md, AGENTS.md, docs/quickstart.mdx, docs/prompting/overview.mdx, docs/guides/skills.mdx, docs/guides/hyperframes-vs-remotion.mdx, docs/packages/cli.mdx.

Why

Not every user's skills CLI supports --full-depth, so the documented command fails for them. A copy-pasteable install command that errors is worse than an install that is occasionally a few hours behind main.

How

Flag removed from the commands; bash comment columns re-aligned in CLAUDE.md and AGENTS.md. Where the docs explained why to keep the flag, the freshness note now points at npx hyperframes skills update, which installs from the current main.

The CLI itself is unchanged: packages/cli/src/commands/skills.ts still passes --full-depth to the skills version it spawns via npx, so hyperframes skills update keeps its freshness guarantee.

Test plan

Docs-only change, no runnable behavior.

  • grep -rn "full-depth" across README.md, CLAUDE.md, AGENTS.md, and docs/ returns nothing.

  • Remaining --full-depth references are confined to packages/cli/src/commands/skills.ts and its test, which are intentionally untouched.

  • Unit tests added/updated

  • Manual testing performed

  • Documentation updated (if applicable)

@mintlify

mintlify Bot commented Aug 21, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview Aug 21, 2026, 6:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@miguel-heygen miguel-heygen changed the title Update skills.mdx docs: drop --full-depth from skills install commands Aug 21, 2026
@miguel-heygen
miguel-heygen merged commit 9ec75a4 into main Aug 21, 2026
47 of 77 checks passed
@miguel-heygen
miguel-heygen deleted the miguel-heygen-patch-1 branch August 21, 2026 18:45
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