docs(agent-skills): clarify when --family is needed vs auto-detected - #539
Open
raj-dubey1 wants to merge 2 commits into
Open
raj-dubey1 wants to merge 2 commits into
raj-dubey1 wants to merge 2 commits into
Conversation
…uired when no framework is detected Explain that `npx @cometchat/skills add` auto-detects the framework inside an app and `--family` is only needed when detection can't resolve one — an empty/new folder (no app yet) or the wrong directory, a monorepo root, or headless SDK/calls skills. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
…mmand in Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NgVCxHs3h8m72GXvC8HaV1
Contributor
Author
|
Added a one-line warning under the empty-folder |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
A support ticket (45571) showed a user running
npx @cometchat/skills addin their home directory (no project yet). Detection correctly found no framework and refused; the user then forced--family react, which installed the skills into the home folder — a false "success" in the wrong place. The confusion: it's unclear from the docs that--familyis optional and only needed when detection can't resolve a framework.This clarifies the detection Note on the Agent Skills page (
agent-skills.mdx).Change
Rewrites the Note under Supported platforms to state plainly:
--familyis optional — runaddinside your app and it auto-detects the platform.cdinto your app first (so files land in the project); otherwise pass--family <platform>.--family.Docs-only; no code changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01PT9pMg3MSZEW3gsb6jPc3E