docs(readme): add 'Coming from npx skills add?' conversion block#980
docs(readme): add 'Coming from npx skills add?' conversion block#980danielmeppiel merged 4 commits intomainfrom
Conversation
Surgical insert between the apm.yml example and the three promises -- the funnel moment where npx-skills users decide whether to switch. Names vercel-labs/agent-skills and the real 'deploy-to-vercel' skill so the claim is verifiable in 30 seconds. Bold inline lead (no h3) keeps the page flow intact for non-npx readers; one outbound link defers prose to docs. Both commands verified locally end-to-end: whole-bundle install integrates 7 skills; --skill deploy-to-vercel integrates 1 and persists the subset into apm.yml + apm.lock.yaml's skill_subset. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a small conversion-oriented README callout for readers familiar with npx skills add, pointing them to equivalent apm install usage for SKILL_BUNDLE-style repos.
Changes:
- Insert a short "Coming from
npx skills add?" block between the clone/install snippet and "The three promises" section. - Add two concrete
apm installexamples (full bundle and--skillsubset). - Add a docs link intended to explain manifest/lockfile/reproducibility for skill bundles.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds an npx skills add conversion block with example apm install commands and a link to package type docs. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
| apm install vercel-labs/agent-skills --skill deploy-to-vercel # one skill, persisted to apm.yml | ||
| ``` | ||
|
|
||
| Same install gesture. You also get a [manifest, lockfile, and reproducibility](https://microsoft.github.io/apm/reference/package-types/#skill-bundle). |
There was a problem hiding this comment.
The link fragment .../reference/package-types/#skill-bundle looks inconsistent with the docs page: docs/src/content/docs/reference/package-types.md has headings ## Skill bundle (SKILL.md at root) and ## Skill collection (skills//SKILL.md) (the latter is the SKILL_BUNDLE/npx-style layout). As written, #skill-bundle is likely not a valid anchor and also points readers at the wrong section. Suggest linking to the package-types page without a fragment, or update the fragment (and/or link text) to target the Skill collection / SKILL_BUNDLE section and verify it matches the rendered site slug.
| Same install gesture. You also get a [manifest, lockfile, and reproducibility](https://microsoft.github.io/apm/reference/package-types/#skill-bundle). | |
| Same install gesture. You also get a [manifest, lockfile, and reproducibility](https://microsoft.github.io/apm/reference/package-types/). |
Copilot reviewer caught: #skill-bundle was wrong on two counts. 1. Rendered anchor is #skill-bundle-skillmd-at-root, not #skill-bundle -- slugifier strips parens/dots/dashes differently than expected. 2. That heading documents the SKILL.md-at-root shape, but npx skills' layout is documented under 'Skill collection (skills/<name>/SKILL.md)' further down the same page. The 'Skill collection' anchor exists in source (added in 0.9.4) but is not deployed yet -- v0.9.4 docs auto-deploy from #953 is mid-rollout. Linking to the page root is robust today and lands on the right doc; both shapes are visible without a scroll. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Thanks @copilot-pull-request-reviewer -- two real issues caught in one comment. Pushed
Linking to the page root is robust today (lands on the right doc, both shapes visible above the fold) and self-correcting once 0.9.4 docs deploy completes. |
Agent-Logs-Url: https://github.com/microsoft/apm/sessions/6725d577-cad3-4772-b2d5-d1d6bf44e926 Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
… docs are live v0.9.4 docs deploy completed (manual workflow_dispatch run 24983311706 after the underlying skip bug was identified -- fix in #981). The live page now exposes #skill-collection-skillsnameskillmd, so we can land readers exactly on the heading that documents the skills/<name>/SKILL.md layout npx skills users already know. Verified live: curl -s .../reference/package-types/ | grep -oE 'id="skill[^"]*"' -> id="skill-bundle-skillmd-at-root" -> id="skill-collection-skillsnameskillmd" Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Update: v0.9.4 docs are now live. The deploy was actually broken in a workflow gate (the skip we saw was not just lag) -- root cause + fix in #981. Manually triggered Restored the precise fragment in So this PR now ships with both the live docs and the right anchor. Conversion funnel from npx-skills users -> APM lands on the heading that matches their existing layout, not on a page they have to scan. |
Promotes [Unreleased] to [0.10.0] - 2026-04-27. Each PR since v0.9.4 gets one 'so what' line: - #926 Microsoft 365 Cowork target ships impl - #790 marketplace authoring CLI (init, package add/set, build, check, outdated, doctor, publish) -- collapsed from 20+ bullets to one - #722 marketplace plugin -> package rename + --help sectioning -- collapsed - #980 README 'Coming from npx skills add' conversion block - #981 docs auto-deploy on tag push (real fix for the #953 attempt) - #985 pr-description-skill evals suite - #984 pr-description-skill mermaid hardening - #989 cowork sys.platform mock for Windows CI Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs: add 'Coming from npx skills add' migration section Add a dedicated section to the migration guide for users arriving from the npx skills add / agentskills.io ecosystem. Covers the drop-in install gesture, --skill flag for selective installs, and persistent selection across machines. This mirrors the README migration table added in v0.10.0 (#980) and brings the docs site to parity. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: address Copilot review on migration page (#1016) - Use American spelling 'recognizes' for consistency - Replace non-ASCII em/en dashes with ASCII per repo policy Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot <copilot-rework@github.com>
TL;DR
Adds one ~5-line "Coming from
npx skills add?" block toREADME.md, sitting between thegit clone / apm installexample and the "three promises" section -- the exact funnel moment where readers familiar withnpx skills adddecide whether to switch. No other content changes.Problem (WHY)
The 0.9.4 release shipped
SKILL_BUNDLE(PR #974) so that every public repo installable vianpx skills add owner/repois also installable viaapm install owner/repo. That is the strongest single conversion claim APM has against the current incumbent in agent-skill installation (skills.sh/vercel-labs/skills), and it is invisible on the README -- so the conversion never happens.Without this block, an
npx skills adduser reading our README sees a manifest-shaped product that looks unrelated to what they do today. The mental cost to evaluate "would this also work for me?" is high enough that most bounce.Approach (WHAT)
A surgical edit, not a rewrite:
git clone / apm installexample (existing line 45) and## The three promises(existing line 47). That is the moment a reader has just understood "what APM does" but has not yet committed to learning more.**Coming from npx skills add?**) -- not an h3 -- so non-npx readers scroll past without losing the page narrative; npx readers self-identify in <1s.apm install vercel-labs/agent-skillsandapm install vercel-labs/agent-skills --skill deploy-to-vercel. Both repos / skill names are real, falsifiable in 30 seconds.reference/package-types/#skill-bundle-- where the SKILL_BUNDLE shape, manifest, and lockfile are already documented. README's job is to convert the click; docs explain.Implementation (HOW)
+Coming from
npx skills add? Drop-in:+
+
bash +apm install vercel-labs/agent-skills # whole bundle, like npx skills add +apm install vercel-labs/agent-skills --skill deploy-to-vercel # one skill, persisted to apm.yml ++
+Same install gesture. You also get a manifest, lockfile, and reproducibility.
+
The three promises
$ apm install vercel-labs/agent-skills
[+] vercel-labs/agent-skills (cached)
|-- 7 skill(s) integrated -> .github/skills/
$ apm install vercel-labs/agent-skills --skill deploy-to-vercel
[+] vercel-labs/agent-skills (cached)
|-- 1 skill(s) integrated -> .github/skills/
[*] Persisted skill subset for vercel-labs/agent-skills: [deploy-to-vercel]
Resulting
apm.lock.yaml:Every claim in the new block (drop-in install,
--skilllever, persistence to apm.yml, lockfile reproducibility) is reproducible from the snippet itself.How to test
git cloneexample and the "three promises" section.apm installcommands above against APM 0.9.4 and confirm the integration counts and theapm.yml/apm.lock.yamlshape match what the block claims.Drift / future-proofing
The block depends on
vercel-labs/agent-skillscontinuing to publish a skill nameddeploy-to-vercel. If we ship a CI job that validates the README install commands against APM regularly, any drift would surface immediately. Not in scope for this PR; flagged for follow-up if the panel wants it.