Skip to content

docs: correct how the skills installer places files - #1643

Merged
obiot merged 3 commits into
masterfrom
claude/readme-skills-install-wording
Sep 5, 2026
Merged

docs: correct how the skills installer places files#1643
obiot merged 3 commits into
masterfrom
claude/readme-skills-install-wording

Conversation

@obiot

@obiot obiot commented Sep 4, 2026

Copy link
Copy Markdown
Member

Description

The description of npx skills add did not match what the installer actually does.

It said the tool "writes each one's own convention" and listed .claude/skills/, .agents/skills/ and .windsurf/skills/ as peer destinations, with "around seventy others".

Running it against a project with Claude Code present shows a different shape. The installer creates one directory per skill under .agents/skills/ — 23 of them, melonjs, melonjs-physics, melonjs-tilemaps and so on — and each detected assistant's directory gets a symlink back to that copy. .claude/skills/melonjs is a symlink to ../../.agents/skills/melonjs, not a second copy. The tool also prints its own coverage figure, "77 agents", so the passage uses that rather than "around seventy".

DOC_README.md carried the same passage, so it is corrected in step (raised in review) and the two files no longer contradict each other.

Documentation only, no code touched.

Type of change

  • Bug fix
  • New feature
  • Documentation update
  • Performance improvement
  • Refactoring (no functional changes)

Checklist

  • I have read the Contributing Guide
  • My code follows the existing code style (pnpm lint passes) — the pre-commit hook globs *.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}, so Markdown is out of scope
  • I have tested my changes locally (pnpm test passes) — verified by running the installer twice and inspecting the resulting tree; no tests cover README prose
  • I have added tests that cover my changes (if applicable)
  • The build succeeds (pnpm build) — unaffected, Markdown only

Related issues

None.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Q8aCt5SwH5D5Bi7qKXi2X8

The README said the installer "writes each one's own convention" and
listed `.claude/skills/`, `.agents/skills/` and `.windsurf/skills/` as
peers, with "around seventy others".

Running it shows otherwise: the skills are installed once into
`.agents/skills/<name>` and symlinked from there into each detected
assistant's directory. After a run with Claude Code present,
`.claude/skills/melonjs` is a symlink to `../../.agents/skills/melonjs`,
not a second copy. The tool reports the figure itself: "77 agents".

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q8aCt5SwH5D5Bi7qKXi2X8
Copilot AI lite review requested due to automatic review settings September 4, 2026 12:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The updated README phrasing is ambiguous about the exact install path and it leaves a duplicate “Skills” install snippet in DOC_README.md with conflicting instructions.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates the README’s npx skills add documentation to match the installer’s actual behavior (single shared install under .agents/skills/ with per-assistant symlinks) and replaces the vague coverage estimate with the tool-reported agent count.

Changes:

  • Describe the shared install location and symlink-based wiring into assistant-specific directories.
  • Replace “around seventy others” with the installer’s reported “77 agents” coverage figure.
File summaries
File Description
README.md Corrects the skills installer behavior description (shared install + symlinks) and updates the stated coverage count.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Comment thread README.md Outdated
Review feedback on the previous commit: `.agents/skills/` read as one
install directory, when the installer creates one directory per skill
(`.agents/skills/melonjs-physics` and 22 siblings) and symlinks each into
the assistant's own directory. The coverage figure is reported by the
tool, not by the location.

DOC_README.md carried the same passage and still described the old
behaviour, so the two files contradicted each other. Correct it there as
well.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q8aCt5SwH5D5Bi7qKXi2X8
Copilot AI review requested due to automatic review settings September 4, 2026 12:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

Documentation-only update appears consistent across both docs and aligns with the stated installer behavior, with only minor optional wording improvements noted.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Lite

Comment thread DOC_README.md Outdated
Comment thread README.md Outdated
Review feedback: the installer's supported-assistant list grows, so a
bare "77 agents" drifts. Keep the figure, since it is what the tool
prints, but frame it as what it reported at the time of writing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q8aCt5SwH5D5Bi7qKXi2X8
Copilot AI review requested due to automatic review settings September 4, 2026 12:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes are documentation-only and consistently update both duplicated installer passages to match the described installer behavior.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

obiot commented Sep 4, 2026

Copy link
Copy Markdown
Member Author

Current state, head f29ed32:

  • Three commits: the original correction, then DOC_README.md brought in line with the README, then the agent count reworded as a snapshot rather than a fixed figure.
  • All four review threads addressed and resolved; the latest Copilot review is approval-recommended.
  • Checks on the head: lint, CodeQL, Analyze (actions), Analyze (javascript) and the Copilot reviewer all green, windows skipped. test is the last one still running, and I will flag it here if it comes back red.

Markdown only, two files, so nothing else should move. Nothing outstanding from my side, it is yours to merge whenever you are happy with the wording.


Generated by Claude Code

@obiot
obiot merged commit 44dc944 into master Sep 5, 2026
7 checks passed
@obiot
obiot deleted the claude/readme-skills-install-wording branch September 5, 2026 17:32
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