github-featured/addyosmani--agent-skills
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

docs: explain per-skill reference limitation

Browse Source
This commit is contained in:
ayobamiseun
2026-08-01 10:28:06 +01:00
parent 7829ffd90d
commit b70fbe910e
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7
View File
@@ -57,6 +57,13 @@ npx skills add addyosmani/agent-skills --skill interview-me # requi
npx skills add addyosmani/agent-skills --skill test-driven-development # red-green-refactor, enforced
```
> **Installing one skill?** A per-skill `npx` install copies only
> `skills/<name>/`, not the repo-level `references/` directory. The skill still
> works, but paths to supplementary shared checklists are unavailable. Use a
> whole-repo integration, clone the repository, or copy the needed checklist into
> a `references/` directory inside the installed skill. This portability gap is
> tracked in [#361](https://github.com/addyosmani/agent-skills/issues/361).
Prefer a native integration? Pick your tool below.
<details>
docs/getting-started.md
+8
View File
@@ -140,6 +140,14 @@ The `references/` directory contains supplementary checklists:
Load a reference when you need detailed patterns beyond what the skill covers.
If you install one skill with `npx skills add ... --skill <name>`, only the
selected `skills/<name>/` directory is copied. The skill still works, but paths
to supplementary checklists in the repo-level `references/` directory are
unavailable. Use a whole-repo integration, clone the repository, or copy the
needed checklist into a `references/` directory inside the installed skill.
This portability gap is tracked in
[addyosmani/agent-skills#361](https://github.com/addyosmani/agent-skills/issues/361).
## Spec and task artifacts
The `/spec` and `/plan` commands create working artifacts (`SPEC.md`, `tasks/plan.md`, `tasks/todo.md`). Treat them as **living documents** while the work is in progress: